Skip to content

How to Use This Repo

Charlie Greenman edited this page Jul 14, 2020 · 4 revisions

This repo uses Markdown. There are three specific things we aim to do differently with this repo:

  1. Include multiple .md files, from multiple folders, into one singular .md file. We use https://github.com/shd101wyy/markdown-preview-enhanced for this.
  2. Pull down code examples, from an external source. This lets us know when it's time to update a particular part of the book. When update made, distribution happens to multiple locations.
  3. Ability to uniquely style code, as well as swap images out, using a content management system.
  4. Create a table of contents + index. Ideally automatically, if possible.

How to Programatically Tell Content Flows Into Next

Checking Grammar

Checking Neutral Voice

How We Include Multiple Files Into One