DEV Community

Discussion on: What are you using for your documentation?

Collapse
 
jldohmann profile image
Jesse

Sphinx is something I've been meaning to check out! A lot of open source projects use it, so it seems useful to know how it works when contributing to a project.

I'm thinking of creating some quickstart projects that use GitLab/GitHub Pages, and GitLab CI / GitHub Actions for automatically building and deploying websites in a GitOps fashion. I'll be including PDF generation as part of the pipelines.

I would be really interested in reading a write up on how you do this, if you ever have the time!

Collapse
 
scriptautomate profile image
Derek Ardolf • Edited

I wanted to update here: I did a rather major pivot toward adopting Dendron, so I want to make sure to mention it here. My long-term goal is to use LaTeX and other tooling that make use of the Markdown notes and docs I take in Dendron. I have converted my main website over to using it: icanteven.io/

A major difference for Dendron is that it isn't just meant to be a publishing tool from a CLI, though that is a definite feature. Dendron is a VSCode / VSCodium extension that provides an excellent UX for knowledge management in general, which the other tools (such as Hugo, Sphinx, Jekyll, etc.) don't have. This has made my life easier, and having the ability to pull documentation from multiple vaults (git repos of documentation) into a single workspace, and to selectively publish a collection of documentation, is really cool.

Now, I've even joined the Dendron team! We cross-post under the Dendron dev.to org here, and the documentation is at wiki.dendron.so. I highly recommend it, and to checkout the growing Discord Community.