Hacker Newsnew | past | comments | ask | show | jobs | submitlogin
Ask HN: What tool do you use for creating technical documentation?
13 points by pravj on May 31, 2018 | hide | past | favorite | 7 comments
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.




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


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


Not my project but doxygen is still the best for C++: http://dailyprog.org/~kenster/docs/TinyCDN/annotated.html


Just write it in Markdown and render it out?


Sphinx. It's capable of output in both HTML and PDF formats.


Currently trying Vuepress. Works great so far!


Wasn't looking for web-based solutions but this one looks great. Better than Slate and README.io on some parameters.




Consider applying for YC's Fall 2025 batch! Applications are open till Aug 4

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: