Sebastien Lorber

Docusaurus 2.0 - Build great docs websites, focus on your content - by Meta

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...

Add a comment

Replies

Best
Umut SΓΆnmez
Wow! This is a game changer. Great move ?makers
MAHDAOUI ABDELOUADOUD
Very nice & clean work! Great work done, Congrats πŸ€—
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.
Giuseppe Avagliano
That's very interesting! Thanks for sharing
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.
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!
Bhuwan Adhikari
Fast and fun. Creating docs with mdx is the best
Sebastien Lorber
@bhuwan_adhikari yes, that really makes the docs more interactive!
David Milaham
This will be a great product for managing and updating sites
Dragos Popescu
Very cool! You can create a website from pretty much anything now haha.
Sebastien Lorber
@drgs thanks :) yes you can great great sites from md files. The idea is not really new but Docusaurus tries to push it a bit forward
Valentina Scamardì
This is really an interesting product. Congrats!
Sebastien Lorber
@valentina_scamardi thanks, glad you like it
djamel cherbal
Useful ! Good job
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
Vincenzo Sorrentino
amazing!
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
Raffaele Di Gennaro
Very nice project!
Dalem Nazim Abdelaziz
Documentations are very important and THIS lets the developers focus on the content
Marija Ilievska
This is so cool!
Johan Steneros
Love Docusarus. I'm not a developer and I got our Knowledge Base setup and going in no time.
Sebastien Lorber
@jsteneros awesome, thanks for the feedback ;)
deepu
congrats