NSDF Markdown Publishing Guide

A guide to publishing Markdown documents on GitHub and ReadTheDocs.

See https://markdown-publishing-guide.readthedocs.io/en/latest/markdown-publishing-guide.html for more details.

Introduction

This is a guide to writing and publishing Markdown documents on GitHub and ReadTheDocs.

It includes steb-by-step instructions for using GitHub, git, Markdown, and ReadTheDocs in order to produce a well-formatted set of documents with a detailed table of contents.

This document itself was created using the instructions in this document.

To build:

pip3 install sphinx
pip3 install sphinx_rtd_theme
sphinx-build ./docs ./_build