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?
@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?
@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
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?
@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.
@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.
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!
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!
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!
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.
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!
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
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.
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.
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!
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
@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.