No description
  • JavaScript 55.2%
  • CSS 36.9%
  • Makefile 4.2%
  • Shell 3.7%
Find a file
zemdregon 50a0c04687
Some checks are pending
CI / Build dist (push) Waiting to run
docs: fold local documentation updates
2026-08-17 09:35:23 -05:00
.github/workflows Initial muxcore-docs: wiki markdown → static dist/ 2026-08-10 10:01:51 -05:00
dist docs: fold local documentation updates 2026-08-17 09:35:23 -05:00
site Initial muxcore-docs: wiki markdown → static dist/ 2026-08-10 10:01:51 -05:00
wiki docs: fold local documentation updates 2026-08-17 09:35:23 -05:00
.gitignore Initial muxcore-docs: wiki markdown → static dist/ 2026-08-10 10:01:51 -05:00
build.mjs Initial muxcore-docs: wiki markdown → static dist/ 2026-08-10 10:01:51 -05:00
build.sh Initial muxcore-docs: wiki markdown → static dist/ 2026-08-10 10:01:51 -05:00
LICENSE Initial muxcore-docs: wiki markdown → static dist/ 2026-08-10 10:01:51 -05:00
Makefile Initial muxcore-docs: wiki markdown → static dist/ 2026-08-10 10:01:51 -05:00
package-lock.json Initial muxcore-docs: wiki markdown → static dist/ 2026-08-10 10:01:51 -05:00
package.json Initial muxcore-docs: wiki markdown → static dist/ 2026-08-10 10:01:51 -05:00
README.md Initial muxcore-docs: wiki markdown → static dist/ 2026-08-10 10:01:51 -05:00

MuxCore Docs

Static HTML site rendered from the MuxCore wiki (core.wiki markdown). Laptop-friendly: no paid GitHub Pages required — ship dist/ in the repo or download the CI artifact / Release.

Quick start

# From a MuxCore workspace that has sibling core.wiki:
make build
# or
./build.sh

# Serve
npx --yes serve dist -l 8080
# or: python3 -m http.server -d dist 8080

Build prefers ../core.wiki when present and syncs into ./wiki/; otherwise uses the committed ./wiki/ snapshot so CI and clones work standalone.

Layout

Path Role
wiki/ Markdown snapshot (GitHub wiki pages)
site/style.css Shared stylesheet
build.mjs Markdown → HTML
dist/ Generated site (index.html = Home)
.github/workflows/ci.yml Self-hosted build + artifact upload

Update content

  1. Edit the wiki (core wiki or local ../core.wiki).
  2. make sync-wiki (or just make build — it syncs automatically).
  3. Commit updated wiki/ and dist/ if you want the repo to serve offline without a rebuild.