Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Ask HN: What are you using for public documentation these days?

news.ycombinator.com

Post reply on HN
Print view View original

41–50 of 111 posts

Re: Ask HN: What are you using for public documentation these days?

#41

Post by stavros »

lelandfe wrote: post #24
navaneethpk wrote: post #15

We are using Docusaurus ( https://docusaurus.io/ ). - it is easy to configure/customise - looks really great out of the box - solid documentation - fast In our case, we just had to change the colors and font. Here is our Docusaurus code if that's helpful: https://github.com/ToolJet/ToolJet/tree/develop/docs and here is the live documentation: https://docs.tooljet.com/

> live documentation: https://docs.tooljet.io The two separate hamburger menus were hard to parse at first on mobile. Do your social media links really deserve higher placement than the navigation?

Oh huh, I completely missed the second hamburger button and was perplexed as to why their documentation only had three links to other sites.

Re: Ask HN: What are you using for public documentation these days?

#42

Post by shafyy »

navaneethpk wrote: post #15

We are using Docusaurus ( https://docusaurus.io/ ). - it is easy to configure/customise - looks really great out of the box - solid documentation - fast In our case, we just had to change the colors and font. Here is our Docusaurus code if that's helpful: https://github.com/ToolJet/ToolJet/tree/develop/docs and here is the live documentation: https://docs.tooljet.com/

I'm also using Docusaurus for Fugu (https://docs.fugu.lol).

One thing that bothers me is that they offer a free Algolia integration for open-source projects, but they declined my application despite being open source.

So, search not working for now, need to have another look at that :-)

Edit: I just got an email from Algolia DocSearch saying that my documentation qualifies after all :-) If someone from that team read my comment and send the email, thanks! If not, it's a big coincidence, also good!

Re: Ask HN: What are you using for public documentation these days?

#43

Post by stavros »

shafyy wrote: post #42
navaneethpk wrote: post #15

We are using Docusaurus ( https://docusaurus.io/ ). - it is easy to configure/customise - looks really great out of the box - solid documentation - fast In our case, we just had to change the colors and font. Here is our Docusaurus code if that's helpful: https://github.com/ToolJet/ToolJet/tree/develop/docs and here is the live documentation: https://docs.tooljet.com/

I'm also using Docusaurus for Fugu ( https://docs.fugu.lol ). One thing that bothers me is that they offer a free Algolia integration for open-source projects, but they declined my application despite being open source. So, search not working for now, need to have another look at that :-) Edit: I just got an email from Algolia DocSearch saying that my documentation qualifies after all :-) If someone from that team re…

It doesn't support search unless you rely on (pay for) Algolia? Wow, instant pass from me.

Re: Ask HN: What are you using for public documentation these days?

#44

Post by navaneethpk »

daviesliu wrote: post #36
navaneethpk wrote: post #15

We are using Docusaurus ( https://docusaurus.io/ ). - it is easy to configure/customise - looks really great out of the box - solid documentation - fast In our case, we just had to change the colors and font. Here is our Docusaurus code if that's helpful: https://github.com/ToolJet/ToolJet/tree/develop/docs and here is the live documentation: https://docs.tooljet.com/

Docusaurus is great! We migrated from Sphinx to Docusaurus[1] recently, the navigation is much better than before. One thing that bothers us: we have not figure a way to name the anchor that both work in Github (` `) and Docusaurus (`{#aws-s3}`), for example [2]. Any ideas? [1] https://juicefs.com/docs/community/introduction [2] https://github.com/juicedata/juicefs/blob/main/docs/en/how_t...

Haven't tried this but will it work on both GitHub and Docusaurus if the section "S3" is renamed as "Amazon S3" and then removing the "{#aws-s3}" part?

Re: Ask HN: What are you using for public documentation these days?

#45

Post by navaneethpk »

shafyy wrote: post #42
navaneethpk wrote: post #15

We are using Docusaurus ( https://docusaurus.io/ ). - it is easy to configure/customise - looks really great out of the box - solid documentation - fast In our case, we just had to change the colors and font. Here is our Docusaurus code if that's helpful: https://github.com/ToolJet/ToolJet/tree/develop/docs and here is the live documentation: https://docs.tooljet.com/

I'm also using Docusaurus for Fugu ( https://docs.fugu.lol ). One thing that bothers me is that they offer a free Algolia integration for open-source projects, but they declined my application despite being open source. So, search not working for now, need to have another look at that :-) Edit: I just got an email from Algolia DocSearch saying that my documentation qualifies after all :-) If someone from that team re…

We tried to use Typesense for the search bar. We could not wrap up the PR due to bandwidth issues but it should be a great alternative for Algolia. Link: https://github.com/typesense/typesense-docsearch-scraper

Re: Ask HN: What are you using for public documentation these days?

#47

Post by shafyy »

navaneethpk wrote: post #45
shafyy wrote: post #42

Earlier quoted context omitted.

I'm also using Docusaurus for Fugu ( https://docs.fugu.lol ). One thing that bothers me is that they offer a free Algolia integration for open-source projects, but they declined my application despite being open source. So, search not working for now, need to have another look at that :-) Edit: I just got an email from Algolia DocSearch saying that my documentation qualifies after all :-) If someone from that team re…

We tried to use Typesense for the search bar. We could not wrap up the PR due to bandwidth issues but it should be a great alternative for Algolia. Link: https://github.com/typesense/typesense-docsearch-scraper

Yes, that looks like a good solution! Thanks!

Re: Ask HN: What are you using for public documentation these days?

#48

Post by acidburnNSA »

stichers wrote: post #4

Basic markdown and Sphinx to build into HTML, publishing via github pages. It's an open source project so putting the docs alongside the code just makes sense. Although Sphinx isn't great for my money, it gets the job done.

I have grown to absolutely love Sphinx. The plugins are wonderful, including Sphinx gallery, jupyter integration, and Sphinx-needs for requirements management.

Re: Ask HN: What are you using for public documentation these days?

#49

Post by shafyy »

stavros wrote: post #43
shafyy wrote: post #42

Earlier quoted context omitted.

I'm also using Docusaurus for Fugu ( https://docs.fugu.lol ). One thing that bothers me is that they offer a free Algolia integration for open-source projects, but they declined my application despite being open source. So, search not working for now, need to have another look at that :-) Edit: I just got an email from Algolia DocSearch saying that my documentation qualifies after all :-) If someone from that team re…

It doesn't support search unless you rely on (pay for) Algolia? Wow, instant pass from me.

You can add your own search plugin or use another provider like Typesense. They just offer an optional free Algolia service for open-source projects on top. You can read more here: https://docusaurus.io/docs/search

Re: Ask HN: What are you using for public documentation these days?

#50

Post by daviesliu »

navaneethpk wrote: post #44
daviesliu wrote: post #36

Earlier quoted context omitted.

Docusaurus is great! We migrated from Sphinx to Docusaurus[1] recently, the navigation is much better than before. One thing that bothers us: we have not figure a way to name the anchor that both work in Github (` `) and Docusaurus (`{#aws-s3}`), for example [2]. Any ideas? [1] https://juicefs.com/docs/community/introduction [2] https://github.com/juicedata/juicefs/blob/main/docs/en/how_t...

Haven't tried this but will it work on both GitHub and Docusaurus if the section "S3" is renamed as "Amazon S3" and then removing the "{#aws-s3}" part?

Yes, we can use `#amazon-s3` as the anchor, then the name could be long, for example, `#digitalocean-spaces-object-storage`), and it will not work in Chinese.

Your suggestion is better than current one, we will use that, thanks!

Post reply on HN