Skip to content

A guide to publishing Markdown documents on GitHub and ReadTheDocs

License

Notifications You must be signed in to change notification settings

ironmeld/markdown-publishing-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Publishing Guide v1.0.3

A guide to publishing Markdown documents on GitHub and ReadTheDocs

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.

Read the document here:

  • Click here for the latest formatted release of the document at readthedocs.io.
  • Click here for the local version of the document in Markdown format.