https://github.com/niclasheinz/mkdocs-material-devcontainer

A simple devcontainer configuration that allows you to run `mkdocs serve` in your devcontainer
https://github.com/niclasheinz/mkdocs-material-devcontainer

devcontainer mkdocs mkdocs-material

Last synced: 17 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/niclasheinz/mkdocs-material-devcontainer
• Owner: niclasheinz
• Created: 2025-01-06T10:29:21.000Z (19 days ago)
• Default Branch: main
• Last Pushed: 2025-01-06T10:49:32.000Z (19 days ago)
• Last Synced: 2025-01-06T11:32:41.739Z (19 days ago)
• Topics: devcontainer, mkdocs, mkdocs-material
• Homepage:
• Size: 1.95 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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

```