Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 696 Bytes

README.md

File metadata and controls

18 lines (13 loc) · 696 Bytes

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