Docusaurus
p/docusaurus
Easy to maintain open source documentation websites
Sebastien Lorber
Docusaurus 2.0 β€” Build great docs websites, focus on your content - by Meta
Featured
152
β€’
Docusaurus helps you ship a top-notch documentation site in no time!
 
Focus on your content: just write Markdown files!
Put your site online in 5 minutes, then customize it.
 
Full-featured: plugins, themes, search, blog, versioning, i18n, React...
Replies
Best
David Leuliette
It's always hard to have good-looking and up-to-date documentation. Thanks to all team for maintaining this project! @sebastienlorber one thing that drives me crazy: no URL for search Example: 1. https://twitter.com/search?q=seb... 2. search done 1. Go https://docs.nativebase.io/ 2. hit command + k 3. type your search 4. get results Is there a way to access the search feature only via an URL + query params?
Sebastien Lorber
@flexbox Thanks David :) As Yangshun answered we have a dedicated search page. Would it be useful to have a way to display the search modal on app open too?
David Leuliette
Thanks @yangshun πŸ™Œ That's what I was looking for @sebastienlorber I think as a small link it can help as an alternative way to search β€”aka using alfred or other launchers IF the search is available I don't know if it's a setting to optin / opout Because It's available on https://reactnative.dev/search?q... and not https://docs.nativebase.io/searc...
Sebastien Lorber
@flexbox the NativeBase doc doesn't have a search page, because it's using Next.js instead of Docusaurus :p Our official Algolia DocSearch plugin has a search page by default, and some community local search plugins too
Sebastien Lorber
@flexbox me too πŸ˜„ as Docusaurus is quite customizable I always wonder and have to inspect the DOM head to be sure
Meenank Minnu
Ahh finally a product that removes the dread out of the documentation process. We all hate paperwork and this name makes me immediately want to sign up. I just have one question to the @sebastienlorber, can we use Docusaurus for courses or wiki site creation?
Sebastien Lorber
@superminnu yes you can use Docuaurus courses and wikis for sure, but I don't see that use-case too often: Some similar sites comparable to what you might be looking for? https://www.techinterviewhandboo... https://react-typescript-cheatsh... Docusaurus remains quite dev centric, using Git and Markdown so it's not really a wiki with a wysiwig editor but more a tool to build a knowledge base and present it in a nice way.
Meenank Minnu
@sebastienlorber I personally find my usecase working truly great for docusaurus. Will share with you what I build next.
Sebastien Lorber
πŸ‘‹ Hey Product Hunt! I'm SΓ©bastien, the current lead maintainer of Docusaurus ⚑️ Docusaurus is a developer tool to build awesome documentation websites! 🏒 Docusaurus comes from Meta Open Source (Facebook), and is one of our most successful open source project (πŸ“ˆ growing fast, strong adoption, 35k+ GitHub stars). Free, MIT license. πŸ§‘β€πŸ’» Technically, it's a React + Node.js static site generator, full-featured with content-centric features (docs, blog, pages, versioning, i18n, a11y, SEO...) that allows you to get started fast and focus on your content: just write Markdown files! 🎨 But it also scales with your usage and is very flexible (plugins, theming...): it is really possible to build great-looking sites that do not look the same πŸ”₯ It also uses MDX: this allows to use React inside Markdown files to make your doc interactive. We believe you don't need to be Stripe and have a full engineering team working on your doc to make it a top-notch experience. A good example is Courier documentation integrating a custom interactive OpenAPI client. πŸ’‘ Docusaurus Story: Meta has a lot of internal/external project. Before Docusaurus, it was a pain to create a new documentation website for each one. We started to copy a Jekill template, but it wasn't really maintainable. Hence we created Docusaurus in 2017. v1 was a success, but was a bit limited in terms of theming, didn't have a plugin system, and we didn't really leverage React, so we started working on a v2 starting 2018. πŸ₯³οΈ Docusaurus v2.0 is now officially released, after a very long alpha/beta phase (4 years πŸ˜…). Please read our Announcing Docusaurus 2.0 post! πŸ“ˆ The community adopted Docusaurus v2 pre-releases even before its launch! In practice Docusaurus 2 has been relatively stable for a while already, but we weren't ready to respect Semantic Versioning. We have a site showcase with almost 300 v2 sites, and it's only the tip of the iceberg. We've heard about strong internal usage at companies such as LinkedIn, Microsoft, Shopify, SAP and many more... The community quicky adopted Docusaurus v2 pre-releases before it's even launched. A sample of great Docusaurus v2 sites: - πŸ”— Figma - πŸ”— Snapchat - πŸ”— Supabase - πŸ”— React-Native - πŸ”— Ionic - πŸ”— StackBlitz - πŸ”— Redis - πŸ”— Algolia DocSearch - πŸ”— Tauri - πŸ”— Hasura - πŸ”— Lacework - πŸ”— Iota - πŸ”— Solana - πŸ”— Cardano ❌ I pitched Docusaurus, now it's also worth explaining its limits. Docusaurus remains a developer tool, requiring basic Node.js knowledge, and you'll also need to know React if you want to build a greatly customized site. The Markdown files are usually stored in Git. If you are not a technical person and ready to use Node.js + Git (or a Git-based CMS), Docusaurus may not be good for you. We plan to improve the authoring experience later, and work on CMS integrations. Docusaurus is not like a Wiki/Confluence where you have a built-in UI to submit edits. ❓ Let me know if you have any question, I'll be happy to answer the pros and cons of Docusaurus in a fair way so that you understand the tradeoffs of Docusaurus. Some comparable tools include: VuePress, VitePress, GitBook, MkDocs, Dokz, Docsify, Gatsby, Nextra... 🎞 Little video demo to show what we mean by "focus on your content": just create a Markdown file and that's it. Note we also have powerful Markdown front matter to customize various things like the position of a doc in the sidebar, the sidebar label, the pagination label, SEO metadata, tags...
Edit: Lee Robinson did a much better video than mine here. In 60 seconds of video you can understand the value of Docusaurus: https://twitter.com/leeerob/stat...
Seb Bryers
@sebastienlorber super clean work! I wondered how Figma's docs were put together, they use the product super well.
Sebastien Lorber
@srbryers Thanks Actually have no idea, discovered their site recently by chance while looking for a Figma API doc . What I can see by inspecting DOM + network request is that they have 2 separate Docusaurus sites for plugins and widgets: - https://www.figma.com/widget-docs/ - https://www.figma.com/plugin-docs/ Navigating from plugins to widgets lead to a full page reload (no SPA navigation) Probably sharing a custom theme or preset between the 2 sites The rest of their docs are not based on Docusaurus. They just made all the things look consistent, but you'll notice some little differences in the layout.
Pierre-Gilles
I've been using Docusaurus for an open-source project I'm maintaining ( Gladys Assistant: https://gladysassistant.com/) since the alpha of this v2 and it saved me tons of time. Docusaurus is an amazing piece of tech, well maintained and easy to use!
Sebastien Lorber
@pierregillesl thanks for being an early adopter of our i18n support ;)
Marcos MuΓ­Γ±o GarcΓ­a
Docusaurus is awesome 😍! We have been using it for more than a year for both our Docs (https://docs.yepcode.io/) and our Recipes Platform (https://yepcode.io/recipes/) and it works like a charm πŸ” Thanks a lot for your amazing work!
Sebastien Lorber
@mmuino great πŸ₯° didn't know these sites, please send them to our site showcase ;)
Swyx
has been a very very long journey, but Docusaurus has rightfully earned its place as the default docs engine for most dev focused companies and startups and OSS libraries. huge congrats to you for shepherding this through AND consistently updating users through the process so that we did not lose confidence. Congrats!
Sebastien Lorber
@swyx Thanks a lot for the feedback ❀️️
Max Lynch
Huge fans of Docusaurus over at Ionic. We've adopted it for all of our docs moving forward. It replaces a ton of custom work we've had to build and maintain over the years and now all our docs are fast and easy to contribute to.
Sebastien Lorber
@maxlynch thanks a lot Max. Really happy to see your Ionic site, it's a been a good example I use to demonstrate the value of Docusaurus
Antonio Langella
I tried lot of documentation tools but never satisfied me - here we have a new and fresh tool, going to check it immediately - thank you for the help!
Julien Delange
Super useful product. We use it to host our documentation at Codiga (https://doc.codiga.io), and it is really easy to setup and use!
Sebastien Lorber
@juli1pb thanks 😍 please submit your site to our showcase, I don't think we have this one
Yangshun Tay
Hi Product Hunt! I was the lead maintainer of Docusaurus from 2018-2020. The first version of Docusaurus was great, it enabled us to build documentation websites very easily by handling everything besides the content for us. However, as the web advanced, users started to ask for more features: adding interactivity, theming, using their React components, etc on the page. Docusaurus 1 was built as a monolith and was fundamentally creating websites with a different architecture. To address the shortcomings of Docusaurus 1, in 2018, we started rearchitecting Docusaurus 2 from the ground up and split V2 into a few core modules: - Infima: a CSS framework written from scratch that helps people build content-driven websites quickly (https://infima.dev/) - Docusaurus core: allows for plugins, themes and page generation - Docusaurus classic preset: a collection of plugins and themes which reimplemented the functionality of Docusaurus 1 for a "works out-of-the-box" experience! It's very extensible and themeable. It has been a multi-year effort and we're glad we're finally shipping it. Check it out!
Vaibhav Shinde
Recently got to use Docusaurus for docs.dyte.io and I must say it's really nice to use, write documentation and ship with a highly customisable system of plugins. We even created a "Section Switcher" specifically made for our use case with the help of its hooks. Kudos ?makers
Sebastien Lorber
@vaibhavshn thanks, really like your section switcher, a good demo of the usefulness of our theme customizeability
Sunghyun Cho
Extremely extensible. I absolutely love it. Already using it on my website https://cho.sh. I hope Docusaurus adds backlinking support soon.
Sebastien Lorber
@anaclumos thanks for the feedback Yes I'd like to add backlinking like Obsidian/Roam in the future
Umut SΓΆnmez
Wow! This is a game changer. Great move ?makers
Giovanni Benussi Paredes
Want to have great docs but don't have time to build your own solution? I've been using it for a while and it has really saved me a lot of work. It has MDX, versioning, TypeScript support, blog, search, and translations. It's blazingly fast, and it's used by some awesome teams in the web dev space.
Sebastien Lorber
@giovanni_benussi_paredes thanks for the great feedback πŸ‘Œ
Seth Carney
Courier made the switch to Docusaurus and then wrote a blog post about it! https://www.courier.com/blog/how... The product has been great!
Sebastien Lorber
@seth81 yes! One of our best site, love it 😍
Alex DeBrie
I've made a few documentation-like sites over the years, and the one I made a few months ago with Docusaurus 2.0 was by far the one I'm happiest with. Super easy to get started, a very clean look, and easy to customize without being a frontend wizard. I don't have a horse in this race other than I want to see better documentation out in the wild. I've recommend this to a few people now, and I wouldn't choose anything else.
Sebastien Lorber
@alex_debrie thanks a lot for your comment ;) glad you liked it
Harsh Bardhan
Congratulations on the launch! I have used Docusaurus for over half a dozen projects now and I am always awe-struck by its simplicity, features, customizations, and the community support available. Great product and an awesome team!
Sebastien Lorber
@harsh_bardhan thanks a lot for the feedback 😍
Hung Nguyen
I've been using Docusaurus pre-release for production sites for a while and it works seamlessly. It's an opinionated solution to document your products and publish blog posts/ updates. If you want to customize it for your own needs, simply use the Swizzling feature, which is super flexible. I hope to see Docusaurus continue to grow to help more people bootstrapping a website effortlessly
Sebastien Lorber
@hellothere123 thanks for sharing your experience ;)
Amin
Is it just me, or is the phrase "by meta" an instant turn-off as it reduces the credibility?
Sebastien Lorber
@footer not just you, but I think it's unfair to bash everything coming from Meta. It's free, open source, MIT license and I am not even a Meta employee myself. It's quite unrelated to Facebook/Instagram and just a good tool that the community can use.
Christophe Chaudier
Docusorus it easy to use. We use Docusaurus for the website of our SaaS : https://froggit.fr/
Sebastien Lorber
@c_chaudier really happy to see it become popular in France, in part thanks to you ;)