Skip to content

Repository files navigation

Mycelium logo

Mycelium-Website

Marketing/landing site for Mycelium, built with MkDocs and Material for MkDocs.

Deployments

Target URL Trigger
Netlify (primary) https://mycelium-gh.netlify.app deploy.yml on push to main
GitHub Pages (mirror) https://myceliumgh-dev.github.io/Mycelium-Website/ same workflow, same push

Component documentation lives in a separate repository: Mycelium-Docs.

Branch model

  • dev is the working branch — land changes here.
  • main is the published branch — nothing reaches the live site until a dev → main PR is merged.
  • prevent-main-into-dev.yml guards the reverse direction; never merge main into dev.
git push origin dev
gh pr create --base main --head dev
gh pr merge --merge

Local development

pip install -r requirements.txt
mkdocs serve

Or with Docker (no local Python needed), serving on http://localhost:8080:

./serve-docker.sh

Release coupling

On every Mycelium plugin release:

  • docs/download.md — current-version row in the table.
  • docs/versions.md — bump the top marker line and add a ### X.Y.Z.W (Month D, YYYY) section above the previous one, body taken from the matching CHANGELOG.md section in the plugin repo. Keep older entries.
  • Then open the dev → main PR — the release is not done until it merges.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages