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

31–40 of 111 posts

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

#31

Post by grodriguez100 »

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/

Aspect ratio of screenshots looks wrong when the docs are browsed from mobile phones. Is this a docusaurus issue or perhaps specific to your docs?

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

#32

Post by franciscop »

djrockstar1 wrote: post #19
franciscop wrote: post #11

I have an unfinished side project called Documentation Page: https://documentation.page/ It's "unfinished" because I'd need to integrate payments and do all the accounting on my side (non-trivial as an individual living in Japan), but otherwise it's worked pretty well for my own projects. It parses your Github Repo to generate the website. You can define your docs as a single readme.md file, a folder called "document…

The examples look really elegant and polished. I could definitely see myself using something like this. It's times like these I wish HN had a save comment button. Also it's pretty funny that a documentation service has incomplete documentation. https://documentation.page/documentation#how-it-works

Thanks! It's unfinished and on-hold for 3rd parties so it doesn't have all docs :)

I might retake it at some point next year to officially finish/launch it, like the code is basically mostly there.

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

#34

Post by navaneethpk »

grodriguez100 wrote: post #31
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/

Aspect ratio of screenshots looks wrong when the docs are browsed from mobile phones. Is this a docusaurus issue or perhaps specific to your docs?

I think it is because we have explicitly set the height of the images (https://github.com/ToolJet/ToolJet/blob/develop/docs/docs/in...). Will fix it.

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

#35

Post by superzamp »

We're using readme.com for https://docs.numary.com/

Pretty satisfied with the productivity gain and the API docs generation from our OpenAPI file.

I just learned that their API would allow us to programmatically update the guide section as well, so we'll probably move the guides to a public github as well for contributions.

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

#36

Post by daviesliu »

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

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

#37

Post by Symbiote »

perfopt wrote: post #8

Is there anything that supports languages other than English - specifically Indian languages. I am writing documentation (book) to be distributed online. I presently use mdbook but markdown does not support anything other than English.

What do you mean by Markdown not supporting other languages? I don't see how it wouldn't support other languages.

Although we're using Asciidoctor (syntax / markup language) with Antora (tooling) ourselves, including with a Chinese translation. It's similar to the Fedora documentation:

https://docs.fedoraproject.org/ur_PK/docs/ (Urdu? Most translations are very incomplete; it's just volunteers.)

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

#39

Post by parkersweb »

I've not used it yet - but planning to give Nextra (https://nextra.vercel.app/) a go next time around.

The 'docs' theme is intended as a quick way to produce a documentation website based on Next, which you can obviously customise further with your own components if needed.

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

#40

Post by grodriguez100 »

Jefro118 wrote: post #25

In case you're using Google docs/drive for docs at the moment, I've built https://neat.wiki for precisely this purpose. If it's documentation for code there are better options though.

Very similar, but free: https://spaceli.io/
Post reply on HN