Template strings in documentation?
Joel Lau

Joel Lau @joellau

About: CRUD app extraordinaire

Location:
Singapore
Joined:
Oct 6, 2017

Template strings in documentation?

Publish Date: Nov 7 '19
2 5

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 ?

Comments 5 total

  • Si
    SiNov 7, 2019

    What language are you using?

    • Joel Lau
      Joel LauNov 7, 2019

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

  • Joel Lau
    Joel LauNov 8, 2019

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

Add comment