TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

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

13 pointsby pravjalmost 7 years ago
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.<p>Sadly, Google Docs isn&#x27;t a great option here even after using add-ons like Code Format and Prettier.<p>Let me know if I&#x27;ve missed something which is already around.

6 comments

tzmalmost 7 years ago
I generate html and render PDF using custom print stylesheets.<p>Tools: mkdocs (or jekyl, hugo, etc), pandoc, PDFtk, chromium (headless), prismjs &#x2F; highlightjs<p>You might be interested in:<p><a href="https:&#x2F;&#x2F;github.com&#x2F;Fiware&#x2F;tools.Md2pdf" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;Fiware&#x2F;tools.Md2pdf</a><p><a href="https:&#x2F;&#x2F;github.com&#x2F;dawnlabs&#x2F;carbon" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;dawnlabs&#x2F;carbon</a>
syyviusalmost 7 years ago
I&#x27;m a huge fan of MDwiki. I&#x27;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.<p><a href="http:&#x2F;&#x2F;dynalon.github.io&#x2F;mdwiki&#x2F;#!index.md" rel="nofollow">http:&#x2F;&#x2F;dynalon.github.io&#x2F;mdwiki&#x2F;#!index.md</a>
mabynogyalmost 7 years ago
Not my project but doxygen is still the best for C++: <a href="http:&#x2F;&#x2F;dailyprog.org&#x2F;~kenster&#x2F;docs&#x2F;TinyCDN&#x2F;annotated.html" rel="nofollow">http:&#x2F;&#x2F;dailyprog.org&#x2F;~kenster&#x2F;docs&#x2F;TinyCDN&#x2F;annotated.html</a>
EvanKnowlesalmost 7 years ago
Just write it in Markdown and render it out?
cimmanomalmost 7 years ago
Sphinx. It&#x27;s capable of output in both HTML and PDF formats.
Siilwynalmost 7 years ago
Currently trying Vuepress. Works great so far!
评论 #17212840 未加载