News for hackers. Stuff that matters.

Ask HN: What tool do you use for creating technical documentation?

I want to create JavaScript and Python SDK documentation to share with (enterprise) clients in portable format likes PDF etc. Solutions like readme.io and readthedocs.io are good only for a web-based approach.

Sadly, Google Docs isn't a great option here even after using add-ons like Code Format and Prettier.

Let me know if I've missed something which is already around.

( 7 comments | 13 points | on HN )
Re:Ask HN: What tool do you use for creating technical docum... by tzm on Thursday May 31, 2018 @07:24AM (#17195502)
I generate html and render PDF using custom print stylesheets.

Tools: mkdocs (or jekyl, hugo, etc), pandoc, PDFtk, chromium (headless), prismjs / highlightjs

You might be interested in:

https://github.com/Fiware/tools.Md2pdf

https://github.com/dawnlabs/carbon

Re:Ask HN: What tool do you use for creating technical docum... by syyvius on Thursday May 31, 2018 @10:49AM (#17196715)
I'm a huge fan of MDwiki. I've used it for documentation, class notes, work logs, and running a dnd campaign. Really good tool for people who want a no-frills markdown rendering client.

http://dynalon.github.io/mdwiki/#!index.md

Re:Ask HN: What tool do you use for creating technical docum... by mabynogy on Thursday May 31, 2018 @07:22AM (#17195492)
Not my project but doxygen is still the best for C++: http://dailyprog.org/~kenster/docs/TinyCDN/annotated.html
Re:Ask HN: What tool do you use for creating technical docum... by EvanKnowles on Thursday May 31, 2018 @06:41AM (#17195327)
Just write it in Markdown and render it out?
Re:Ask HN: What tool do you use for creating technical docum... by cimmanom on Thursday May 31, 2018 @06:47AM (#17195351)
Sphinx. It's capable of output in both HTML and PDF formats.
Re:Ask HN: What tool do you use for creating technical docum... by Siilwyn on Friday June 01, 2018 @02:17PM (#17208363)
Currently trying Vuepress. Works great so far!
Re:Ask HN: What tool do you use for creating technical docum... by pravj on Saturday June 02, 2018 @01:10AM (#17212840)
Wasn't looking for web-based solutions but this one looks great. Better than Slate and README.io on some parameters.