ReddCoin Knowledgebase (MkDocs) — v0.14

This repository is an MkDocs (Material theme) documentation site.

View locally

Option A: Python + pip (recommended)

python -m venv .venv
# Windows: .venv\\Scripts\\activate
source .venv/bin/activate

pip install -r requirements.txt
mkdocs serve

Then open the local URL shown in the terminal (usually http://127.0.0.1:8000/).

Build a static site

pip install -r requirements.txt
mkdocs build

The static site is written to the site/ directory.

Deploy to GitHub Pages

Recommended: GitHub Actions (auto-deploy on push)

1. Push this repo to GitHub.
2. In your GitHub repo, go to Settings → Pages.
3. Under Build and deployment, set Source to GitHub Actions.
4. Push to main (or run the workflow manually). The site will deploy automatically.

The workflow file is at .github/workflows/pages.yml.

Alternative: deploy to gh-pages branch (manual)

pip install -r requirements.txt
mkdocs gh-deploy --force

Then in Settings → Pages, set the publishing source to the gh-pages branch and / (root).

Notes

• If you use a project repo (e.g. reddcoin-kb) your Pages URL will be: https://<USER_OR_ORG>.github.io/<REPO_NAME>/
• If you use a user/org Pages repo (e.g. <USER_OR_ORG>.github.io) your site will be at: https://<USER_OR_ORG>.github.io/

Deploy to GitHub Pages using the GitHub web UI (no local tooling)

This is the “web GUI only” approach (useful when you have a ZIP archive and want to publish fast).

1) Create or open the repo

1. In GitHub, create/open the repo (example: reddcoin-project/knowledgebase).
2. Ensure the default branch is main.

2) Upload the ZIP contents

1. Download and unzip the archive on your computer.
2. In GitHub, open the repo → click Add file → Upload files.
3. Drag the unzipped contents (folders like docs/, .github/, plus files like mkdocs.yml, requirements.txt, README.md) into the uploader.
4. Scroll down and Commit changes to main.

Tip: Don’t upload the ZIP itself. Upload the contents of the ZIP.

3) Enable Pages (GitHub Actions)

1. Repo → Settings → Pages
2. Under Build and deployment, set Source to GitHub Actions.

4) Trigger the build

• Go to Actions → select the Pages workflow (from .github/workflows/pages.yml) → Run workflow
  or just push/commit another small change to trigger it.

When the workflow completes, GitHub Pages will publish at:

• https://<org>.github.io/<repo>/

---