4 ms·

Plenty of comments wondering if you need all of these features to build good docs. You don’t. What you might find is that once you’ve built a good docs site, yo

Plenty of comments wondering if you need all of these features to build good docs. You don’t. What you might find is that once you’ve built a good docs site, you need a small customisation. Maybe an in-line code sample runner. Maybe you’d like to make it more SEO friendly. Or search. Again, any of these features can be built. If you enjoy building just what you need, go ahead. What Docusaurus offers is all of these features pre-built. You’ll have access to the solution as soon as you encounter the problem.

slorber 4y ago
Thanks nindalf! Yes that's the value prop of Docusaurus: you can get started in 5 minutes, but the tool scales well with your usage if you need something more advanced
_fat_santa 4y ago
What I found out is that because Docusaurus is so popular, you get a form of standardization across docs. I can go from React Native docs to Redux docs to TailwindCSS docs and I've already got a solid idea of where everything will be because its a docusarus site. One thing in particular is that Docusarus has the CMD + K command to do a search, it's so nice being able to go to all the different sites for docs and have the UI work in exactly the same way.
- slorber 4y ago
  Thanks for the feedback To be fair what you describe is more a side-result of our community rather than our own features. CMD+K is a popular shortcut. It's not built-in Algolia DocSearch modal. Also other frameworks like VitePress have a similar experience: https://vitepress.vuejs.org/ https://vitepress.vuejs.org/
  - swyx 4y ago
    if i have 1 piece of feedback about docusaurus docsearch, it is that doing faceted search (eg to filter for languages, or library versions) is not at all documented. i've tried multiple times and failed. if someone from Algolia is reading this, we could really use your help there, it would greatly increase the experience of all docs via docusaurus and improve Algolia integration.
    - slorber 4y ago
      Thanks for the feedback We call this "contextual search": https://docusaurus.io/docs/search#contextual-search https://docusaurus.io/docs/search#contextual-search It's now enabled by default and facet on version + language so normally you don't have to do anything (like it was the case on v1). Now we don't provide very good APIs to customize this default facetted search, so it's more all or nothing. Is this solving your use-case or you need something else?

slorber 4y ago

Thanks nindalf! Yes that's the value prop of Docusaurus: you can get started in 5 minutes, but the tool scales well with your usage if you need something more advanced

_fat_santa 4y ago

What I found out is that because Docusaurus is so popular, you get a form of standardization across docs. I can go from React Native docs to Redux docs to TailwindCSS docs and I've already got a solid idea of where everything will be because its a docusarus site. One thing in particular is that Docusarus has the CMD + K command to do a search, it's so nice being able to go to all the different sites for docs and have the UI work in exactly the same way.

slorber 4y ago
Thanks for the feedback To be fair what you describe is more a side-result of our community rather than our own features. CMD+K is a popular shortcut. It's not built-in Algolia DocSearch modal. Also other frameworks like VitePress have a similar experience: https://vitepress.vuejs.org/ https://vitepress.vuejs.org/
- swyx 4y ago
  if i have 1 piece of feedback about docusaurus docsearch, it is that doing faceted search (eg to filter for languages, or library versions) is not at all documented. i've tried multiple times and failed. if someone from Algolia is reading this, we could really use your help there, it would greatly increase the experience of all docs via docusaurus and improve Algolia integration.
  - slorber 4y ago
    Thanks for the feedback We call this "contextual search": https://docusaurus.io/docs/search#contextual-search https://docusaurus.io/docs/search#contextual-search It's now enabled by default and facet on version + language so normally you don't have to do anything (like it was the case on v1). Now we don't provide very good APIs to customize this default facetted search, so it's more all or nothing. Is this solving your use-case or you need something else?