Skip to content

cn-writing/mkdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MkDocs

Usage

  1. Create a folder where your Markdown files will be. That folder needs to have the following structure:

     <MARKDOWN_ARTICLES_PATH>
         docs
             *.md
         mkdocs.yml
    
  2. The mkdocs..yml file contains all the settings for you site. Check more options on https://www.mkdocs.org/

  3. Run the container

     docker run -p 8000:8000 -v <MARKDOWN_ARTICLES_PATH>:/docs jnonino/mkdocs