Skip to content

Instantly share code, notes, and snippets.

@ozcanyarimdunya
Last active March 20, 2019 22:33
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ozcanyarimdunya/8f87d704024e48005b207e5a1661634e to your computer and use it in GitHub Desktop.
Save ozcanyarimdunya/8f87d704024e48005b207e5a1661634e to your computer and use it in GitHub Desktop.
How to create mkdocs on your local with docker

File structure

project/
├── docs
│   ├── about.md
│   ├── assets
│   │   └── back.png
│   ├── index.md
│   └── installation.md
└── mkdocs.yml

mkdocs.yml

site_name: Demo
nav:
    - 'index.md'
    - Installation: installation.md
    - About: about.md
theme:
  name: 'material'

index.md

# Welcome to our project

![image](assets/back.png)

1. [Installation](/installation/)
2. [About](/about/)

Run in local

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
@ozcanyarimdunya
Copy link
Author

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment