Ask HN: What are you using for public documentation these days? • Hacker News Board

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

#21

Post by evolve2k » Thu, Nov 18, 2021, 12:54 PM UTC

tomw1808 wrote: post #6

I'm using mkdocs with the material plugins [1]. I'm running it mainly for a Blockchain Education site for my labs from my course, which seems to be fine [2]. I did a fair amount of customization though, so I am running all this as mkdocs plugins, not directly from the materials project. [1] https://squidfunk.github.io/mkdocs-material/ [2] https://ethereum-blockchain-developer.com

Oh wow this looks great! Simple conversion of markdown into an opinionated simple to use really nice looking doc site.!

Cheers for this :)

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

#22

Post by fenesiistvan » Thu, Nov 18, 2021, 12:57 PM UTC

MS Word converted with some tools to html, chm, pdf.

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

#23

Post by andix » Thu, Nov 18, 2021, 12:58 PM UTC

Markdown in Git, Gitlab or GitHub. KISS.

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

#24

Post by lelandfe » Thu, Nov 18, 2021, 1:08 PM UTC

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?

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

#25

Post by Jefro118 » Thu, Nov 18, 2021, 1:15 PM UTC

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.

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

#26

Post by ryannevius » Thu, Nov 18, 2021, 1:15 PM UTC

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

If you click on the timestamp for the comment, you'll be presented with an option to "favorite" the comment.

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

#27

Post by navaneethpk » Thu, Nov 18, 2021, 1:16 PM UTC

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?

You are right, placing the navigation on the sidebar is more useful than the links to GitHub and Slack.

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

#28

Post by samcrawford » Thu, Nov 18, 2021, 1:18 PM UTC

https://www.mkdocs.org/. Probably not the latest or greatest, but it produces nice looking documentation from markdown. Serves my purposes well.

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

#29

Post by 4kelly » Thu, Nov 18, 2021, 1:23 PM UTC

tomw1808 wrote: post #6

I'm using mkdocs with the material plugins [1]. I'm running it mainly for a Blockchain Education site for my labs from my course, which seems to be fine [2]. I did a fair amount of customization though, so I am running all this as mkdocs plugins, not directly from the materials project. [1] https://squidfunk.github.io/mkdocs-material/ [2] https://ethereum-blockchain-developer.com

+1 for Material MkDocs. It’s beautiful and functional by default so I can just focus on documenting.

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

#30

Post by warpech » Thu, Nov 18, 2021, 1:34 PM UTC

We (Handsontable) now use VuePress[1] for our docs[2] and we are very happy with it. The best feature for us is the ease of customization.

Our challenge right now with the docs is to get a fantastic code snippet runner there. But that's beyond the scope of your regular documentation management tool, I suppose. VuePress will make it easy for us to integrate our solution.

[1] https://vuepress.vuejs.org/

[2] https://handsontable.com/docs/