read-the-docs-test

This project is for testing the capabilities of GitHub pages and Read the Docs.

Github pages

Followed this tutorial.

Github Page

Read the Docs

Link

Markdown User Guide

Configuration

  1. Create mkdocs.yml file in the root of the repo:
    site_name: Site Name
    theme: readthedocs
    
  2. Create docs directory.
  3. Create project at Read the Docs.

Good reference for markdown Read the Docs is Automapper.

Links

2