I'm looking into doing more writing and documentation and one of the biggest problems I'm facing is keeping certain pieces of information up to date.
For example, I named Chapter 2: Usage, referred to it a few times, and decided that I would like to change the title to Chapter 2: Tutorial .
Are there any existing solutions that would allow me to store these values somewhere as a single source of truth ?
For further actions, you may consider blocking this person and/or reporting abuse
Bump.sh generates an always up-to-date API reference site for REST and Event-Driven Architectures.
Plug it in your CI. It fetches your OpenAPI and AsyncAPI (GraphQL pending) spec files, and even generates a diff. Gather all of your API docs in a single source of truth.
Mike Young -
DbVisualizer -
Mike Young -
Mike Young -
Top comments (5)
What language are you using?
as of now, just github flavoured markdown and html (different projects). but i'm open to anything at this point
How about using Jekyll templates with liquid ?
this was what I was looking for, thanks!
I'm also considering using sphinx / restructuredText as they support more features (substitutions, tags, citations)