Replace MkDocs with static GitHub Pages site

Replace the MkDocs-based docs with a plain static site under docs/: add HTML pages, .nojekyll, and updated CSS; remove original markdown sources and mkdocs.yml. Update CI to upload the docs/ directory (remove MkDocs setup/build steps and use docs path), adjust README instructions to preview the static site locally, and remove MkDocs-related extras from pyproject.toml. Overall switches the project from a MkDocs workflow to prebuilt static pages for GitHub Pages.

Author: CptPlastic

.github/workflows/docs.yml

@@ -5,13 +5,11 @@ on:
     branches: ["main", "master"]
     paths:
       - "docs/**"
-      - "mkdocs.yml"
       - ".github/workflows/docs.yml"
   pull_request:
     branches: ["main", "master"]
     paths:
       - "docs/**"
-      - "mkdocs.yml"
       - ".github/workflows/docs.yml"
   workflow_dispatch:
 
@@ -31,22 +29,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-
-      - name: Install docs dependencies
-        run: |
-          pip install mkdocs mkdocs-material
-
-      - name: Build docs
-        run: mkdocs build --strict
-
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: site
+          path: docs
 
   deploy:
     if: github.event_name != 'pull_request'

README.md

@@ -139,24 +139,24 @@ If dense model loading fails, lore automatically falls back to TF-IDF so search
 
 ## Documentation site (GitHub Pages)
 
-This repository now includes a docs site scaffold in `docs/` using MkDocs.
+This repository now includes a plain static docs site in `docs/` for GitHub Pages.
 
-Run docs locally:
+Preview locally:
 
 ```sh
-pip install "lore-book[docs]"
-mkdocs serve
+cd docs
+python3 -m http.server 8000
 ```
 
-Build docs locally:
+Then open:
 
-```sh
-mkdocs build --strict
+```text
+http://localhost:8000
 ```
 
 Publishing is handled by `.github/workflows/docs.yml` on pushes to `main`/`master`.
 
-To migrate existing docs pages into this repo, copy markdown files into `docs/` and update `nav` in `mkdocs.yml`.
+To migrate existing docs pages into this repo, add or edit static files under `docs/`.
 
 ---
 

docs/.nojekyll

@@ -11,82 +11,89 @@
 
 @import url("https://fonts.googleapis.com/css2?family=Cinzel:wght@400;600;900&family=Crimson+Text:ital,wght@0,400;0,600;1,400&display=swap");
 
-.md-main {
+* {
+  box-sizing: border-box;
+}
+
+html {
+  scroll-behavior: smooth;
+}
+
+body {
+  margin: 0;
   background-color: #1a1208;
   background-image:
     radial-gradient(ellipse at 50% 0%, rgba(200, 151, 58, 0.08) 0%, transparent 70%),
     url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='400' height='400'%3E%3Cfilter id='n'%3E%3CfeTurbulence type='fractalNoise' baseFrequency='0.65' numOctaves='3' stitchTiles='stitch'/%3E%3C/filter%3E%3Crect width='400' height='400' filter='url(%23n)' opacity='0.04'/%3E%3C/svg%3E");
-}
-
-.md-content {
   color: var(--ink);
   font-family: "Crimson Text", Georgia, serif;
   font-size: 19px;
   line-height: 1.75;
+  min-height: 100vh;
 }
 
-.md-content__inner {
-  margin: 0;
-  padding-top: 0;
-}
-
-.md-content__inner:before {
-  display: none;
+a {
+  color: inherit;
 }
 
-.md-content h1,
-.md-content h2,
-.md-content h3,
-.md-header__title,
-.md-tabs__link {
+h1,
+h2,
+h3 {
   font-family: "Cinzel", serif;
 }
 
-.legacy-home {
-  position: relative;
-  min-height: 100vh;
+.site-nav-wrap {
+  position: sticky;
+  top: 0;
+  z-index: 4;
+  backdrop-filter: blur(10px);
+  background: rgba(26, 18, 8, 0.74);
+  border-bottom: 1px solid rgba(200, 151, 58, 0.18);
 }
 
-body.legacy-home-page .md-header,
-body.legacy-home-page .md-sidebar,
-body.legacy-home-page .md-tabs,
-body.legacy-home-page .md-footer {
-  display: none;
+.site-nav {
+  width: min(100%, 1100px);
+  margin: 0 auto;
+  padding: 0.85rem 1.5rem;
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  gap: 1rem;
 }
 
-body.legacy-home-page .md-main__inner {
-  display: flex;
-  justify-content: center;
-  align-items: flex-start;
-  margin: 0;
-  padding: 0;
-  max-width: none;
-  min-height: 100vh;
+.site-brand,
+.site-link {
+  text-decoration: none;
 }
 
-body.legacy-home-page .md-content {
-  flex: 1 1 auto;
-  width: 100%;
-  max-width: none;
-  margin: 0 auto;
+.site-brand {
+  font-family: "Cinzel", serif;
+  font-size: 1.05rem;
+  letter-spacing: 0.12em;
+  color: var(--gold-bright);
 }
 
-body.legacy-home-page .md-content__inner {
-  width: 100%;
-  margin: 0;
-  padding: 0;
+.site-links {
+  display: flex;
+  flex-wrap: wrap;
+  justify-content: center;
+  gap: 0.35rem 0.8rem;
 }
 
-body.legacy-home-page .md-grid {
-  max-width: none;
-  margin: 0;
+.site-link {
+  font-family: "Cinzel", serif;
+  font-size: 0.82rem;
+  letter-spacing: 0.1em;
+  color: var(--parchment-dark);
+  padding: 0.28rem 0.4rem;
+  border-bottom: 1px solid transparent;
 }
 
-body.legacy-home-page .md-container,
-body.legacy-home-page .md-main,
-body.legacy-home-page .md-content,
-body.legacy-home-page article.md-content__inner {
-  overflow: visible;
+.site-link:hover,
+.site-link.active,
+.site-brand.active {
+  color: var(--gold-bright);
+  border-color: rgba(232, 184, 75, 0.6);
 }
 
 #sparkles {
@@ -110,6 +117,10 @@ body.legacy-home-page article.md-content__inner {
   align-items: center;
 }
 
+.docs-page {
+  padding-top: 2.4rem;
+}
+
 .cover {
   text-align: center;
   padding: 4rem 2rem 3rem;
@@ -173,6 +184,26 @@ body.legacy-home-page article.md-content__inner {
   margin-right: auto;
 }
 
+.simple-hero {
+  text-align: center;
+}
+
+.simple-hero h1 {
+  margin: 0;
+  font-size: clamp(2.3rem, 6vw, 3.7rem);
+  color: var(--gold-bright);
+  text-shadow: 0 0 30px rgba(232, 184, 75, 0.22);
+}
+
+.eyebrow {
+  margin: 0 0 0.6rem;
+  font-family: "Cinzel", serif;
+  font-size: 0.8rem;
+  letter-spacing: 0.18em;
+  text-transform: uppercase;
+  color: var(--gold);
+}
+
 .parchment {
   background: var(--parchment);
   background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='300' height='300'%3E%3Cfilter id='n'%3E%3CfeTurbulence type='fractalNoise' baseFrequency='0.9' numOctaves='4' stitchTiles='stitch'/%3E%3C/filter%3E%3Crect width='300' height='300' filter='url(%23n)' opacity='0.07'/%3E%3C/svg%3E");
@@ -298,6 +329,10 @@ body.legacy-home-page article.md-content__inner {
   text-decoration: none;
 }
 
+.target-item a:hover {
+  text-decoration: underline;
+}
+
 .link-rune {
   font-family: "Cinzel", serif;
   font-size: 0.85rem;
@@ -397,6 +432,15 @@ body.legacy-home-page article.md-content__inner {
 }
 
 @media (max-width: 600px) {
+  body {
+    font-size: 18px;
+  }
+
+  .site-nav {
+    padding: 0.8rem 0.9rem;
+    flex-direction: column;
+  }
+
   .page {
     padding: 2rem 0.85rem 4rem;
   }
@@ -409,10 +453,6 @@ body.legacy-home-page article.md-content__inner {
     font-size: 1.05rem;
   }
 
-  .md-content {
-    font-size: 18px;
-  }
-
   .target-list,
   .command-columns {
     grid-template-columns: 1fr;

docs/assets/stylesheets/homebrew-legacy.css

@@ -0,0 +1,51 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <title>CLI · Lore</title>
+  <meta name="description" content="Lore CLI" />
+  <link rel="canonical" href="https://cptplastic.github.io/lore-book/cli/" />
+  <link rel="stylesheet" href="../assets/stylesheets/homebrew-legacy.css" />
+</head>
+<body>
+  <canvas id="sparkles"></canvas>
+  <header class="site-nav-wrap">
+    <nav class="site-nav" aria-label="Primary">
+      <a class="site-brand" href="../">Lore</a>
+      <div class="site-links">
+        <a class="site-link" href="../install/">Install</a>
+        <a class="site-link" href="../concepts/">Concepts</a>
+        <a class="site-link active" href="./">CLI</a>
+        <a class="site-link" href="../faq/">FAQ</a>
+        <a class="site-link" href="https://github.com/CptPlastic/lore-book">GitHub</a>
+      </div>
+    </nav>
+  </header>
+
+  <main class="page docs-page">
+    <section class="parchment simple-hero">
+      <p class="eyebrow">Lore Documentation</p>
+      <h1>CLI</h1>
+      <p class="tagline">Core commands for onboarding, capture, search, and export.</p>
+    </section>
+
+    <section class="parchment">
+      <h2><span class="rune">✦</span> Onboard</h2>
+      <div class="incantation">lore onboard</div>
+      <h2><span class="rune">⚜</span> Add Memory</h2>
+      <div class="incantation">lore add decisions "Use PostgreSQL for row-level locking"</div>
+      <h2><span class="rune">✧</span> Search Memory</h2>
+      <div class="incantation">lore search "why did we choose postgres"</div>
+      <h2><span class="rune">⌘</span> Export Context Files</h2>
+      <div class="incantation">lore export</div>
+    </section>
+
+    <div class="links">
+      <a class="link-rune" href="../">✦ Home</a>
+      <a class="link-rune" href="../faq/">⚜ FAQ</a>
+    </div>
+  </main>
+  <script src="../assets/javascripts/homebrew-legacy.js"></script>
+</body>
+</html>