/mkdocs

Custom Docker image with Mkdocs

Primary LanguageShellMIT LicenseMIT

MkDocs Docker Image

Linter   GitHub release   GitHub

Custom Docker image with MkDocs.

About

Docker based documentation testing suite based on MkDocs.

Uses Material as default theme.

Dependencies

  • Docker
  • A working mkdocs.yml in the root of your repository

Install

docker pull pendect/mkdocs

Usage

From the root of your repository

Help

docker run -it --rm -v `pwd`:/docs pendect/mkdocs:latest help

Build a project

docker run -it --rm -v `pwd`:/docs pendect/mkdocs:latest build

Serve a project

docker run -it --rm -p 8000:8000 -v `pwd`:/docs pendect/mkdocs:latest serve

New project

docker run -it --rm -v `pwd`:/docs pendect/mkdocs:latest new

Contributing

Pull requests are welcome.

For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

About

Pendect is reshaping the way you navigate your daily flood of news.

Stay up to date with news events across the globe and be a part in the fight against fake news.

Follow us

pendecthq on twitter