Docusaurus

useful product

Wow! This is a game changer. Great move ?makers

Very nice & clean work! Great work done, Congrats 🤗

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

That's very interesting! Thanks for sharing

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?

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!