mordoc 0.1.13 → 1.0.0

package/package.json

@@ -1,63 +1,48 @@
 {
-    "name": "mordoc",
-    "repoitory": {
-        "type": "git",
-        "url": "https://github.com/shiva-varanasi/mordoc.git"
-    },
-    "version": "0.1.13",
-    "description": "A static site generator for documentation with SSG + SPA capabilities",
-    "bin": {
-        "mordoc": "./bin/cli.js"
-    },
-    "files": [
-        "dist",
-        "templates"
-    ],
-    "scripts": {
-        "compile": "tsc",
-        "prebundle": "node scripts/prebundle.js",
-        "copy-assets": "node scripts/copy-assets.js",
-        "build": "tsc && npm run prebundle && npm run copy-assets",
-        "dev": "node bin/cli.js dev",
-        "test-build": "node bin/cli.js build",
-        "prepublishOnly": "npm run build"
-    },
-    "keywords": [
-        "documentation",
-        "static-site-generator",
-        "ssg",
-        "markdown",
-        "markdoc",
-        "react"
-    ],
-    "author": "Shiva Varanasi",
-    "license": "MIT",
-    "dependencies": {
-        "@markdoc/markdoc": "^0.5.4",
-        "fast-glob": "^3.3.3",
-        "js-yaml": "^4.1.0",
-        "pagefind": "^1.4.0",
-        "prismjs": "^1.30.0",
-        "react": "^19.2.3",
-        "react-dom": "^19.2.3",
-        "react-router-dom": "^7.9.3",
-        "sirv-cli": "^2.0.2",
-        "ws": "^8.18.3",
-        "esbuild": "^0.25.10"
-    },
-    "devDependencies": {
-        "@types/js-yaml": "^4.0.9",
-        "@types/node": "^24.6.2",
-        "@types/react": "^19.2.3",
-        "@types/react-dom": "^19.2.3",
-        "@types/prismjs": "^1.26.5",
-        "@types/ws": "^8.18.1",
-        "esbuild": "^0.25.10",
-        "eslint": "^9.36.0",
-        "prettier": "^3.6.2",
-        "typescript": "^5.9.3"
-    },
-    "engines": {
-        "node": ">=18.0.0"
-    }
+  "name": "mordoc",
+  "version": "1.0.0",
+  "description": "A modern documentation site generator powered by Vite, React, and Markdoc.",
+  "type": "module",
+  "files": [
+    "dist/",
+    "bin/",
+    "src/app/"
+  ],
+  "bin": {
+    "mordoc": "bin/cli.js"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "author": "Shiva Varanasi",
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [
+    "documentation",
+    "static-site-generator",
+    "markdoc",
+    "vite",
+    "react"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^25.6.0",
+    "@types/prismjs": "^1.26.6",
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@markdoc/markdoc": "^0.5.7",
+    "@vitejs/plugin-react": "^4.7.0",
+    "js-yaml": "^4.1.1",
+    "pagefind": "^1.5.2",
+    "prismjs": "^1.30.0",
+    "react": "^19.2.5",
+    "react-dom": "^19.2.5",
+    "react-router": "^7.14.2",
+    "vite": "^6.4.2"
+  }
 }

package/src/app/App.module.css

@@ -0,0 +1,82 @@
+/* ── Full page shell ──────────────────────────────────────── */
+.app {
+  display: flex;
+  flex-direction: column;
+  min-height: 100vh;
+  width: 100%;
+  background: var(--color-bg);
+}
+
+/* ── Header area — structural box only ───────────────────── */
+/* Aesthetics (background, border, backdrop) live in Header.module.css */
+/* Height is intentionally auto — the header's flex column drives it */
+.headerArea {
+  position: sticky;
+  top: 0;
+  z-index: 50;
+  width: 100%;
+}
+
+/* ── Body row — sidenav | content ────────────────────────── */
+.layout {
+  flex: 1;
+  display: flex;
+  width: 100%;
+  min-height: 0;
+}
+
+/* ── Sidenav area ─────────────────────────────────────────── */
+/* Aesthetics (background, border-right) live in Sidenav.module.css */
+.sidenavArea {
+  position: sticky;
+  top: var(--header-total);
+  align-self: flex-start;
+  width: var(--sidebar-width);
+  height: calc(100svh - var(--header-total));
+  overflow-y: auto;
+  flex-shrink: 0;
+  background: var(--color-bg);
+  border-right: 1px solid var(--color-border);
+}
+
+/* ── Content area — everything right of sidenav ──────────── */
+.contentArea {
+  flex: 1;
+  min-width: 0;
+}
+
+/* ── Mobile overlay behind open sidenav ──────────────────── */
+.overlay {
+  position: fixed;
+  inset: 0;
+  top: var(--header-total);
+  background: rgba(0, 0, 0, 0.4);
+  z-index: 35;
+}
+
+/* ════════════════════════════════════════════════════════════
+   Responsive
+   ════════════════════════════════════════════════════════════ */
+
+/* TOC visibility is handled in Content.module.css */
+
+/* Tablet / mobile — sidenav goes off-canvas */
+@media (max-width: 767.98px) {
+  :root {
+    --page-gutter: 1rem;
+  }
+
+  .sidenavArea {
+    position: fixed;
+    top: var(--header-total);
+    left: 0;
+    transform: translateX(-100%);
+    transition: transform 200ms ease;
+    z-index: 40;
+    height: calc(100svh - var(--header-total));
+  }
+
+  .sidenavAreaOpen {
+    transform: translateX(0);
+  }
+}

package/src/app/App.tsx

@@ -0,0 +1,95 @@
+import { useEffect, useState } from 'react';
+import { Outlet, ScrollRestoration, useLocation, useMatches, useNavigation } from 'react-router';
+import { Header } from './header/Header.js';
+import { Sidenav } from './sidenav/Sidenav.js';
+import { SearchModal, switchPagefind } from './header/SearchModal.js';
+import { Skeleton } from './skeleton/Skeleton.js';
+import { useMordocData } from './data-context.js';
+import { detectCurrentLang } from './lang-utils.js';
+import styles from './App.module.css';
+
+export function App() {
+  const [sidenavOpen, setSidenavOpen] = useState(false);
+  const [searchOpen, setSearchOpen] = useState(false);
+  const location = useLocation();
+  const matches = useMatches();
+  const { navigation, site, language } = useMordocData();
+  const currentLang = detectCurrentLang(location.pathname, language, site.defaultLanguage);
+
+  const routerNav = useNavigation();
+  const currentLayout = (matches.at(-1)?.handle as { layout?: string } | undefined)?.layout ?? 'content';
+  const isLanding = currentLayout === 'landing';
+
+  // Close sidenav on navigation (mobile)
+  useEffect(() => {
+    setSidenavOpen(false);
+  }, [location.pathname]);
+
+  // Sync <html lang> and Pagefind index whenever the active language changes.
+  // Runs on initial mount (initial preload) and on every language switch.
+  useEffect(() => {
+    document.documentElement.lang = currentLang;
+    if (!import.meta.env.DEV) {
+      const hasMultiLang = language !== null && language.languages.length > 1;
+      const indexPath = hasMultiLang
+        ? `/pagefind-${currentLang}/pagefind.js`
+        : '/pagefind/pagefind.js';
+      switchPagefind(indexPath);
+    }
+  }, [currentLang]); // eslint-disable-line react-hooks/exhaustive-deps
+
+  // Global Cmd/Ctrl+K shortcut to open search
+  useEffect(() => {
+    function handleKeyDown(e: KeyboardEvent) {
+      if ((e.metaKey || e.ctrlKey) && e.key === 'k') {
+        e.preventDefault();
+        setSearchOpen(true);
+      }
+    }
+    document.addEventListener('keydown', handleKeyDown);
+    return () => document.removeEventListener('keydown', handleKeyDown);
+  }, []);
+
+  // Keep --topnav-height in sync so sticky offsets (sidenav, TOC, scroll-margin)
+  // stay correct whether or not a topnav row is present.
+  useEffect(() => {
+    document.documentElement.style.setProperty(
+      '--topnav-height',
+      navigation.kind === 'topnav' ? '2.75rem' : '0px',
+    );
+  }, [navigation.kind]);
+
+  return (
+    <div className={styles.app}>
+      <ScrollRestoration />
+      <Header
+        sidenavOpen={sidenavOpen}
+        onMenuToggle={() => setSidenavOpen((o) => !o)}
+        onSearchOpen={() => setSearchOpen(true)}
+        showMenu={!isLanding}
+        className={styles.headerArea}
+      />
+      <SearchModal open={searchOpen} onClose={() => setSearchOpen(false)} />
+      <div className={styles.layout}>
+        {!isLanding && (
+          <aside
+            className={`${styles.sidenavArea} ${sidenavOpen ? styles.sidenavAreaOpen : ''}`}
+            aria-label="Side navigation"
+          >
+            <Sidenav />
+          </aside>
+        )}
+        {!isLanding && sidenavOpen && (
+          <div
+            className={styles.overlay}
+            onClick={() => setSidenavOpen(false)}
+            aria-hidden="true"
+          />
+        )}
+        <div className={styles.contentArea}>
+          {routerNav.state === 'loading' ? <Skeleton /> : <Outlet />}
+        </div>
+      </div>
+    </div>
+  );
+}

package/src/app/content/Content.module.css

@@ -0,0 +1,357 @@
+/* ============================================================
+   CONTENT TOKENS
+   ============================================================ */
+:root {
+  --breadcrumb-link:       #6b6b6b;
+  --breadcrumb-link-hover: #1c1c1c;
+  --breadcrumb-current:    #1c1c1c;
+  --breadcrumb-sep:        #6b6b6b;
+}
+
+:global(.dark) {
+  --breadcrumb-link:       #a0a0a0;
+  --breadcrumb-link-hover: #eaeaea;
+  --breadcrumb-current:    #eaeaea;
+  --breadcrumb-sep:        #6b6b6b;
+}
+
+/* ── Content area grid ──────────────────────────────────────
+   Grid areas: [contentColumn | tocColumn]
+                [footerRow     |     .    ]
+   ─────────────────────────────────────────────────────────── */
+.contentAreaGrid {
+  display: grid;
+  grid-template-columns: 1fr var(--toc-width);
+  grid-template-rows: 1fr auto;
+  grid-template-areas:
+    "content  toc"
+    "footer   .  ";
+  min-height: calc(100svh - var(--header-total));
+}
+
+/* ── Article area ────────────────────────────────────────── */
+.articleArea {
+  grid-area: content;
+  min-width: 0;
+}
+
+/* Reading column — centered within contentColumn */
+.article {
+  max-width: var(--content-max-width);
+  width: 100%;
+  margin: 0 auto;
+  padding: 3rem 1.5rem;
+}
+
+@media (min-width: 768px) {
+  .article {
+    padding: 3rem 2rem;
+  }
+}
+
+/* ── TOC area ────────────────────────────────────────────── */
+.tocArea {
+  grid-area: toc;
+  position: sticky;
+  top: var(--header-total);
+  align-self: start;
+  max-height: calc(100svh - var(--header-total));
+  overflow-y: auto;
+  padding: 3rem 1.5rem 2rem 1.5rem;
+}
+
+/* ── Footer area — spans only under article, never under TOC ─ */
+.footerArea {
+  grid-area: footer;
+}
+
+/* ── Responsive — hide TOC below xl ─────────────────────── */
+@media (max-width: 1279.98px) {
+  .contentAreaGrid {
+    grid-template-columns: 1fr;
+    grid-template-rows: 1fr auto;
+    grid-template-areas:
+      "content"
+      "footer";
+  }
+
+  .tocArea {
+    display: none;
+  }
+}
+
+/* ── Breadcrumb ─────────────────────────────────────────── */
+
+.breadcrumb {
+  display: flex;
+  align-items: center;
+  flex-wrap: wrap;
+  gap: 0.25rem;
+  margin-bottom: 1.25rem;
+  font-size: 14px;
+  font-weight: 400;
+}
+
+.breadcrumbItem {
+  display: flex;
+  align-items: center;
+  gap: 0.25rem;
+}
+
+.breadcrumbSep {
+  display: flex;
+  align-items: center;
+  flex-shrink: 0;
+  color: var(--breadcrumb-sep);
+}
+
+.breadcrumbLink {
+  color: var(--breadcrumb-link);
+  text-decoration: none;
+  cursor: pointer;
+  transition: color 200ms ease;
+}
+
+.breadcrumbLink:hover {
+  color: var(--breadcrumb-link-hover);
+}
+
+.breadcrumbLink:focus-visible {
+  outline: 2px solid var(--accent-emphasis);
+  outline-offset: 2px;
+  border-radius: 2px;
+}
+
+.breadcrumbMuted {
+  color: var(--breadcrumb-link);
+}
+
+.breadcrumbCurrent {
+  color: var(--breadcrumb-current);
+  font-weight: 400;
+}
+
+/* ── Article header ─────────────────────────────────────── */
+
+.articleHeader {
+  margin-bottom: 2.5rem;
+  padding-bottom: 1rem;
+  border-bottom: 1px solid var(--color-border);
+  opacity: 1;
+}
+
+.title {
+  margin: 0 0 16px;
+  font-size: 40px;
+  font-weight: 700;
+  line-height: 1.2;
+  letter-spacing: -0.02em;
+  color: var(--color-fg);
+}
+
+.description {
+  margin: 0 0 16px;
+  font-size: 1rem;
+  line-height: 1.7;
+  color: var(--color-content-fg);
+  max-width: 42rem;
+}
+
+.metaRow {
+  display: flex;
+  align-items: center;
+  gap: 1rem;
+}
+
+.readTime {
+  font-size: 0.75rem;
+  font-weight: 400;
+  text-transform: uppercase;
+  letter-spacing: 0.05em;
+  color: var(--color-fg-muted);
+  opacity: 0.7;
+}
+
+/* ── Prose — Markdoc-rendered content ──────────────────── */
+
+.prose :global(h2) {
+  margin: 40px 0 16px;
+  font-size: 30px;
+  font-weight: 600;
+  line-height: 1.3;
+  letter-spacing: -0.01em;
+  color: var(--color-fg);
+  scroll-margin-top: calc(var(--header-total) + 1.5rem);
+}
+
+.prose :global(h3) {
+  margin: 32px 0 12px;
+  font-size: 24px;
+  font-weight: 600;
+  line-height: 1.4;
+  letter-spacing: -0.01em;
+  color: var(--color-fg);
+  scroll-margin-top: calc(var(--header-total) + 1.5rem);
+}
+
+.prose :global(h4) {
+  margin: 24px 0 8px;
+  font-size: 20px;
+  font-weight: 600;
+  line-height: 1.5;
+  letter-spacing: 0;
+  color: var(--color-fg);
+  scroll-margin-top: calc(var(--header-total) + 1.5rem);
+}
+
+.prose :global(h5) {
+  margin: 20px 0 8px;
+  font-size: 18px;
+  font-weight: 600;
+  line-height: 1.5;
+  letter-spacing: 0;
+  color: var(--color-fg);
+  scroll-margin-top: calc(var(--header-total) + 1.5rem);
+}
+
+.prose :global(h6) {
+  margin: 16px 0 8px;
+  font-size: 16px;
+  font-weight: 600;
+  line-height: 1.5;
+  letter-spacing: 0.01em;
+  color: var(--color-fg);
+  scroll-margin-top: calc(var(--header-total) + 1.5rem);
+}
+
+.prose :global(p) {
+  margin: 0 0 16px;
+  font-size: 16px;
+  line-height: 1.7;
+  font-weight: 400;
+  color: var(--color-content-fg);
+}
+
+.prose :global(ul),
+.prose :global(ol) {
+  margin: 0 0 16px 16px;
+  padding: 0;
+  font-size: 16px;
+  line-height: 1.7;
+  color: var(--color-content-fg);
+}
+
+.prose :global(ul) {
+  list-style: disc inside;
+}
+
+.prose :global(ol) {
+  list-style: decimal inside;
+}
+
+.prose :global(li) {
+  margin-bottom: 0;
+}
+
+.prose :global(li + li) {
+  margin-top: 8px;
+}
+
+.prose :global(li > ul),
+.prose :global(li > ol) {
+  margin-top: 8px;
+  margin-bottom: 0;
+}
+
+.prose :global(blockquote) {
+  margin: 1.25rem 0;
+  padding: 0.75rem 1.25rem;
+  border-left: 3px solid var(--color-border);
+  background: var(--color-surface);
+  border-radius: 0 var(--radius-md) var(--radius-md) 0;
+  color: var(--color-fg-muted);
+  font-style: italic;
+}
+
+.prose :global(blockquote p) {
+  margin: 0;
+}
+
+.prose :global(hr) {
+  margin: 2rem 0;
+  border: none;
+  border-top: 1px solid var(--color-border);
+}
+
+/* Target only plain inline links (no class) — component links like cards manage
+   their own decoration and must not be underlined by prose styles. */
+.prose :global(a:not([class])) {
+  color: var(--accent-emphasis);
+  text-decoration: underline;
+  text-underline-offset: 2px;
+  text-decoration-color: transparent;
+  transition: text-decoration-color 0.15s;
+}
+
+.prose :global(a:not([class]):hover) {
+  color: var(--accent-strong);
+  text-decoration-color: var(--accent-strong);
+}
+
+.prose :global(strong) {
+  font-weight: 600;
+  color: var(--color-fg);
+}
+
+.prose :global(em) {
+  font-style: italic;
+}
+
+/* Inline code */
+.prose :global(code) {
+  padding: 0.1em 0.375em;
+  background: var(--color-surface);
+  color: var(--color-content-fg);
+  border: 1px solid var(--color-border);
+  border-radius: var(--radius-sm);
+  font-family: var(--font-mono);
+  font-size: 0.875em;
+  font-weight: 500;
+}
+
+/* Reset inline-code styles for code inside a pre — the CodeBlock component owns that styling */
+.prose :global(pre code) {
+  padding: 0;
+  background: none;
+  border: none;
+  border-radius: 0;
+  font-size: inherit;
+  font-weight: 400;
+}
+
+/* Tables */
+.prose :global(table) {
+  width: 100%;
+  margin: 1.25rem 0;
+  border-collapse: collapse;
+  font-size: 0.9rem;
+}
+
+.prose :global(th) {
+  padding: 0.625rem 0.875rem;
+  text-align: left;
+  font-weight: 600;
+  font-size: 0.8125rem;
+  color: var(--color-fg);
+  border-bottom: 1px solid var(--color-border);
+}
+
+.prose :global(td) {
+  padding: 0.625rem 0.875rem;
+  border-bottom: 1px solid var(--color-border);
+  vertical-align: top;
+}
+
+.prose :global(tr:last-child td) {
+  border-bottom: none;
+}