An open API service indexing awesome lists of open source software.

https://github.com/cn-docker/mkdocs

MkDocs Image
https://github.com/cn-docker/mkdocs

container-image docker mkdocs mkdocs-docker mkdocs-sites writing

Last synced: about 1 month ago
JSON representation

MkDocs Image

Awesome Lists containing this project

README

          

# MkDocs

[![](https://img.shields.io/github/license/cn-writing/mkdocs)](https://github.com/cn-writing/mkdocs)
[![](https://img.shields.io/github/issues/cn-writing/mkdocs)](https://github.com/cn-writing/mkdocs)
[![](https://img.shields.io/github/issues-closed/cn-writing/mkdocs)](https://github.com/cn-writing/mkdocs)
[![](https://img.shields.io/github/languages/code-size/cn-writing/mkdocs)](https://github.com/cn-writing/mkdocs)
[![](https://img.shields.io/github/repo-size/cn-writing/mkdocs)](https://github.com/cn-writing/mkdocs)

## Usage

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


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 :/docs jnonino/mkdocs