Private Rendered Study Site
The repository is the source-controlled study system. MkDocs Material turns the same Markdown into a cleaner website-style reading experience with sidebar navigation, search, breadcrumbs, dark/light mode, in-page tables of contents, and previous/next footer navigation.
Privacy rule
This repository contains licensed/private DMBOK study material and local chapter-source PDFs.
Do not deploy this site to an unrestricted public URL.
Best browser-native private option — GitHub Codespaces
The repository now includes .devcontainer/devcontainer.json specifically for the study site.
When you create a Codespace from this repository it will:
- create a Python environment;
- install
mkdocs-materialfromrequirements-site.txt; - start
mkdocs serveautomatically on port 8000; - automatically forward port 8000 and label it CDMP Private Study Site;
- open the rendered site in your browser when the forwarded port becomes available.
GitHub Codespaces forwarded ports are private by default. Keep the study-site port private; do not change it to Public.
Use it
- Open this repository on GitHub.
- Click Code.
- Open the Codespaces tab.
- Create a codespace on
main. - Allow the container setup to finish.
- The CDMP Private Study Site port should open automatically.
- If it does not, open the Ports panel and click the URL beside port 8000.
The browser view is the website-style interface. The GitHub repository remains the source-controlled version behind it.
Private build artifact option
The repository also includes:
.github/workflows/build-private-study-site.yml
This workflow builds the site but does not deploy it.
- Open the repository's Actions tab.
- Open Build Private Study Site.
- Run the workflow manually, or use a successful run created by a study-site change.
- Download the artifact named
cdmp-private-study-site. - Extract the ZIP on your computer.
- Serve the extracted folder through a local web server for the best search/navigation behavior.
Windows — simple local server
If Python is installed, open Command Prompt inside the extracted artifact folder and run:
python -m http.server 8000
Then open:
http://localhost:8000
Stop the local server with Ctrl+C when finished.
Build directly from a local clone
If the repository is cloned locally:
python -m pip install -r requirements-site.txt
mkdocs serve
Then use the local address shown by MkDocs.
For a static build instead:
mkdocs build --clean
The rendered site is written to site/.
What the rendered interface adds
- top-level tabs for major program areas;
- collapsible sidebar navigation;
- every chapter grouped by exam weight;
- chapter section links for Overview, Learn, Exam Map, Visuals, Battle Cards, Scenarios, Questions, Recall, and Source;
- full-text search across the MkDocs study pages;
- dark/light mode;
- breadcrumbs and in-page table of contents;
- previous/next footer navigation for pages represented in the site navigation;
- the same source-grounded Markdown and local PDFs already stored in GitHub.
Why normal GitHub Pages is not enabled
This repository is owned by a personal account and contains licensed/private study material. GitHub's private Pages access-control feature requires an eligible organization using GitHub Enterprise Cloud; otherwise a Pages site can be publicly accessible even when its source repository is private.
For this repository, use private Codespaces, the private Actions artifact, or a local build unless/until an authenticated hosting environment is intentionally selected.
What remains authoritative
- DMBOK source: each chapter's local
source/original-dmbok-chapter.pdfplus its controlling Drive source. - Formatted originals: current Drive Docs/Sheet/PDFs linked from each chapter's Source panel.
- Study conversion: GitHub Markdown.
- Learner completion: the live Google execution checklist, not repository completeness.
- Artifact 08: real learner performance only.