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.Share your code in live editors to get your users to love your products on the spot.Write interactive components via JSX and React embedded in Markdown.Page-specific SEO to help your users land on your official docs directly relating their problems at hand.HTML files are statically generated for every possible path.We share our best practices to help you build your docs site right and well. Our shared goal-to help your users quickly find what they need and understand your products better. Publish to GitHub Pages, Netlify, Vercel, and other deployment services with ease.Hot reloading with lightning-fast incremental build on changes. Universal configuration entry point to make it more maintainable by contributors.Open source your plugins to share with the community.Bootstrap your site with a basic template, then use advanced features and plugins.Gain full control of your site's browsing experience by providing your own React components.Features ĭocusaurus is built with high attention to the developer and contributor experience. ❌ You need support for IE11 (.do you? IE has already reached end-of-life and is no longer officially supported)įor existing v1 users that are seeking to upgrade to v2, you can follow our migration guide.❌ You don't want a single-page application (SPA).✅ You want the full power of React and MDX.✅ You want a single-page application (SPA) with client-side routing.✅ You want a modern Jamstack documentation site.After v2's official release, we highly encourage you to use Docusaurus v2 over Docusaurus v1, as Docusaurus v1 has been deprecated.Ī lot of users are already using Docusaurus v2 ( trends). Docusaurus v2 has been a total rewrite from Docusaurus v1, taking advantage of a completely modernized toolchain.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |