Others
我一向倡导的学习方式就是阅读官方文档,好的技术一定有好的文档。而阅读官方文档分成三个阶段:
- 刚开始接触的时候,通篇阅读。对要学的东西有一个宏观认识和理解。
理解,就是要明白一项技术的设计初衷、背后的哲学。学习任何一项技术、语言、框架之初,都要问自己几个问题:
- 为什么要出现这个新东西?之前同类或类似的东西有什么不好吗?
- 这个东西带来哪些新思想和设计哲学,解决了之前哪些不容易解决的问题?
- 发明人对我们有什么建议,可以让我们更好地利用这个东西?
带着上面的问题去阅读文档。有不理解的部分不用怕,因为不可能第一遍读文档就理解全部。不理解的部分要记下来,便于今后返回来查阅。
很多人都不注意上面这些问题,而是上来就应用,人家用我就用,或者公司要求用,或者追时髦用。按照自己以前的经验和想法用别人按不同思想开发出来的技术,越用越难受,然后就得出结论:这个东西不成熟,坑很多。
开始实践。只有实践才出真知。也只有实践才能对之前以为自己理解的部分又更深入的认识,也只有实践才能把之前不理解的部分想明白。有些概念必须在实际问题环境中才能看明白想清楚。这时候,遇到问题要返回去查阅文档相对应的部分。因为你在第一阶段已经对文档结构有了了解。
在用了一段时间后,认为自己已经算是“熟悉”了。在不忙的时候,回过头重新把文档再通读一遍。这时候你会发现自己站在了一个新的高度,也会发现文档中的一些观点是自己以前没有注意的,这种感觉就对了。
这篇文档就算是我在第 3 阶段之后的一篇总结,分享给大家。
Why docs features? How to modify the path of pages (eg., docs)? [2 steps] How to reuse duplicated pages in docs? (.mdx) How to add tags to docs, especially multiple tags? How are docs ids defined? How can we modify? How are docs url defined? How can we modify? design rules for sidebars
Markdown Features
Code Blocks
How to create multi-tabitem blocks?
Admonitions
How to use with Prettier? How to modify the title? How can we use outside MDX, like in JSX? (How to modify the type/icon/title?)
Assets
How to import images/files? [several ways]