Skip to content

A simple devcontainer configuration that allows you to run `mkdocs serve` in your devcontainer

Notifications You must be signed in to change notification settings

niclasheinz/mkdocs-material-devcontainer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MkDocs Material Devcontainer

To be able to use the live preview of mkdocs via GitHub Codespaces, you must release the standard port 8000. So that you don't have to do this manually, you can also create a .devcontainer/devcontainer.json and write the configuration into it. This configuration will be used automatically when you create a new devcontainer.

After that you can execute mkdocs serve in the terminal to start the live preview.

This is what the project structure of my simple documentation looks like:

├── .devcontainer
│   └── devcontainer.json
├── README.md
├── docs
│   └── index.md
├── mkdocs.yml
└── requirements.txt

About

A simple devcontainer configuration that allows you to run `mkdocs serve` in your devcontainer

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published