Skip to content

2023

Publishing Documentation to GH Pages

The use case I was trying to fulfill:

  1. Have a reasonably unified authoring environment for the different content that I intend to write.
  2. Favor some sort of open source markup language over proprietary WYSIWYG editors. Candidates were Markdown, Latex, ReSTructured Text.
  3. Benefit from the version and change control that Github provides
  4. Be able to share the results with colleagues
  5. Be able to reuse the set up to document other projects in Github.
  6. Be able to easily embed rich math expressions and UML or similar diagrams
  7. Bonus:
    1. Be able to publish to Medium and other syndication platforms.
    2. Somewhat just for nostalgic reasons, be able to author Latex documents in the same environment and publish them.