![]() We've also studied other main static site generators and would like to share our insights on the comparison, hopefully helping you navigate through the prismatic choices out there. Comparison with other tools Īcross all static site generators, Docusaurus has a unique focus on documentation sites and has many out-of-the-box features. Hence we're dedicating effort to explaining the architecture and various components of Docusaurus with the hope that users reading it will gain a deeper understanding of the tool and be even more proficient in using it. We believe that, as developers, knowing how a library works helps us become better at using it. Choice of Markdown engines, CSS frameworks, CSS methodology, and other architectures will be entirely up to users. Certain core infrastructures like React Loadable and React Router cannot be swapped because we do default performance optimization on them, but not higher-level ones. Users are not required to use the default plugins or CSS, although they are highly encouraged to. Common and popular performance optimizations and configurations will be done for users but they are given the option to override them. The separations of concerns between each layer of our stack (content/theming/styling) should be clear-well-abstracted and modular. It should look intuitive and easy to build on top of, using approaches they are familiar with. Users will not feel overwhelmed when looking at the project directory of a Docusaurus project or adding new features. Mandatory talk- Minimal API Surface Area. Not having abstractions is better than having the wrong abstractions, and we don't want users to have to hack around the wrong abstractions. Most things will still be achievable by users, even if it takes them more code and more time to write. Docusaurus should be easy to learn and use as the API is quite small. Attention to accessibility, making your site equally accessible to all users. Docusaurus 2 follows the PRPL Pattern that makes sure your content loads blazing fast. □ Internationalization (i18n): Translate your site in multiple locales.ĭocusaurus 2 is born to be compassionately accessible to all your users, and lightning-fast.□ Document Versioning: Helps you keep documentation in sync with project releases. ![]() □ Search: Your full site is searchable. ![]()
0 Comments
Leave a Reply. |