Template strings in documentation?

twitter logo github logo ・1 min read

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 ?

twitter logo DISCUSS (5)
markdown guide
 
 

as of now, just github flavoured markdown and html (different projects). but i'm open to anything at this point

 
 

I'm also considering using sphinx / restructuredText as they support more features (substitutions, tags, citations)

Classic DEV Post from Mar 19

Jack of the Stack

Different developer types described by the alphabet.

JoelLau profile image
Less is more, both with code, and with design