@inovus-medical/docs 0.1.0 → 0.2.1

package/bin/cli.js

@@ -3,6 +3,7 @@ import path from 'node:path'
 import { build } from '../src/build.js'
 import { serve } from '../src/serve.js'
 import { watchAndRebuild } from '../src/watch.js'
+import { init } from '../src/init.js'
 
 function parseFlags(args) {
   const opts = {}
@@ -32,6 +33,22 @@ const outDir = flags.out || 'dist'
 const port = Number(flags.port || 8788)
 
 async function run() {
+  if (cmd === 'init') {
+    const { created, skipped, name, title, visibility, repoUrl, home } = await init({ root, flags })
+    console.log(`Scaffolded "${title}" (worker: ${name}, ${visibility})${repoUrl ? ` — ${repoUrl}` : ''}`)
+    if (created.length) console.log('  created: ' + created.join(', '))
+    if (skipped.length) console.log('  kept existing (use --force to overwrite): ' + skipped.join(', '))
+    if (!home) {
+      console.log('  ⚠ No home page (README.md / index.md) and --no-readme set — the site will have no page at /.')
+    }
+    console.log('\nNext:')
+    console.log('  npm install')
+    console.log('  npm run dev        # preview at http://localhost:8788')
+    console.log('  git add -A && git commit -m "Add docs site config" && git push')
+    console.log('  then connect the repo in Cloudflare (build: npm install && npm run build)')
+    return
+  }
+
   if (cmd === 'build') {
     const { pageCount, outPath, contentDir } = await build({ root, inDir, outDir })
     console.log(`✓ Built ${pageCount} page(s) from ${contentDir === '.' ? 'repo root' : contentDir + '/'} -> ${path.relative(process.cwd(), outPath) || outPath}`)
@@ -54,7 +71,14 @@ async function run() {
     return
   }
 
-  console.error(`Unknown command: ${cmd}\nUsage: inovus-docs <build|dev|serve> [--root .] [--in docs] [--out dist] [--port 8788]`)
+  console.error(
+    `Unknown command: ${cmd}\n` +
+      `Usage:\n` +
+      `  inovus-docs init   [--name <n>] [--title <t>] [--public] [--repo <url>] [--no-readme] [--force]\n` +
+      `  inovus-docs build  [--root .] [--in <dir>] [--out dist]\n` +
+      `  inovus-docs dev    [--port 8788]\n` +
+      `  inovus-docs serve  [--port 8788]`
+  )
   process.exit(1)
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inovus-medical/docs",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Turn a folder of markdown into a themed, Cloudflare-ready docs site.",
   "type": "module",
   "bin": {

package/src/build.js

@@ -117,7 +117,16 @@ export async function build({ root = process.cwd(), inDir, outDir = 'dist' } = {
     const routeSegments = isIndex ? dirSegments : rawSegments
     const route = toRoute(routeSegments)
 
-    const { html, headings, text, title } = renderer.render(content)
+    let rendered
+    try {
+      rendered = renderer.render(content)
+    } catch (err) {
+      const rel = path.relative(contentRoot, file)
+      console.warn(`⚠ Could not fully render ${rel}: ${err.message} — falling back to plain text.`)
+      const escaped = content.replace(/[&<>]/g, (c) => ({ '&': '&amp;', '<': '&lt;', '>': '&gt;' }[c]))
+      rendered = { html: `<pre>${escaped}</pre>`, headings: [], text: content.slice(0, 2000), title: null }
+    }
+    const { html, headings, text, title } = rendered
     const pageTitle = data.title || title || (isIndex ? titleCase(dirSegments[dirSegments.length - 1] || config.title) : titleCase(leaf))
 
     const page = {

package/src/init.js

@@ -0,0 +1,173 @@
+import { promises as fs } from 'node:fs'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { execSync } from 'node:child_process'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+async function fileExists(p) {
+  try { await fs.access(p); return true } catch { return false }
+}
+
+async function readJsonIfExists(file) {
+  try { return JSON.parse(await fs.readFile(file, 'utf8')) } catch (e) {
+    if (e.code === 'ENOENT') return null
+    throw e
+  }
+}
+
+function gitRemote(root) {
+  try {
+    return execSync('git config --get remote.origin.url', {
+      cwd: root,
+      stdio: ['ignore', 'pipe', 'ignore']
+    }).toString().trim() || null
+  } catch {
+    return null
+  }
+}
+
+function parseRemote(url) {
+  if (!url) return {}
+  const m = url.match(/[:/]([^/:]+)\/([^/]+?)(?:\.git)?$/)
+  if (!m) return {}
+  const [, org, repo] = m
+  let httpsUrl
+  if (url.startsWith('git@')) {
+    const hm = url.match(/git@([^:]+):(.+?)(?:\.git)?$/)
+    httpsUrl = hm ? `https://${hm[1]}/${hm[2]}` : null
+  } else {
+    httpsUrl = url.replace(/\.git$/, '')
+  }
+  return { org, repo, httpsUrl }
+}
+
+function sanitizeName(s) {
+  return (
+    String(s).toLowerCase().replace(/[^a-z0-9-]+/g, '-').replace(/^-+|-+$/g, '').slice(0, 54) ||
+    'docs-site'
+  )
+}
+
+function titleCase(s) {
+  return String(s).replace(/[-_]/g, ' ').replace(/\s+/g, ' ').trim().replace(/\b\w/g, (c) => c.toUpperCase())
+}
+
+const WRANGLER = (name) => `{
+  "$schema": "node_modules/wrangler/config-schema.json",
+  "name": "${name}",
+  "compatibility_date": "2025-06-01",
+  "assets": {
+    "directory": "./dist",
+    "html_handling": "auto-trailing-slash",
+    "not_found_handling": "404-page"
+  }
+}
+`
+
+async function ensureGitignore(root, created) {
+  const file = path.join(root, '.gitignore')
+  let body = ''
+  try { body = await fs.readFile(file, 'utf8') } catch {}
+  const present = new Set(body.split(/\r?\n/).map((l) => l.trim()))
+  let next = body
+  let changed = false
+  for (const entry of ['node_modules/', 'dist/']) {
+    if (!present.has(entry)) {
+      next += (next && !next.endsWith('\n') ? '\n' : '') + entry + '\n'
+      changed = true
+    }
+  }
+  if (changed) {
+    await fs.writeFile(file, next)
+    created.push(body ? '.gitignore (updated)' : '.gitignore')
+  }
+}
+
+async function hasHomePage(root) {
+  const candidates = ['README.md', 'readme.md', 'index.md', 'docs/README.md', 'docs/index.md']
+  for (const c of candidates) if (await fileExists(path.join(root, c))) return true
+  return false
+}
+
+function starterReadme(title) {
+  return `# ${title}
+
+Welcome to the ${title} documentation.
+
+This is the home page of your docs site. Edit this \`README.md\` to change it, and add
+more \`.md\` files anywhere in the repo — they show up in the sidebar automatically.
+`
+}
+
+/** Scaffold the per-repo files needed to publish a markdown repo as a docs site. */
+export async function init({ root = process.cwd(), flags = {} } = {}) {
+  const enginePkg = JSON.parse(await fs.readFile(path.join(__dirname, '..', 'package.json'), 'utf8'))
+  const engineVersion = `^${enginePkg.version}`
+
+  const remote = parseRemote(gitRemote(root))
+  const folder = path.basename(root)
+  const name = sanitizeName(flags.name || remote.repo || folder)
+  const title = flags.title || titleCase(remote.repo || folder)
+  const visibility = flags.public ? 'public' : 'private'
+  const repoUrl = flags.repo || remote.httpsUrl || null
+  const force = flags.force === true
+
+  const created = []
+  const skipped = []
+
+  // docs.config.json (don't clobber existing unless --force)
+  const cfgPath = path.join(root, 'docs.config.json')
+  if ((await fileExists(cfgPath)) && !force) {
+    skipped.push('docs.config.json')
+  } else {
+    const cfg = { title, description: '', visibility }
+    if (repoUrl) cfg.repo = repoUrl
+    await fs.writeFile(cfgPath, JSON.stringify(cfg, null, 2) + '\n')
+    created.push('docs.config.json')
+  }
+
+  // wrangler.jsonc
+  const wranglerPath = path.join(root, 'wrangler.jsonc')
+  if ((await fileExists(wranglerPath)) && !force) {
+    skipped.push('wrangler.jsonc')
+  } else {
+    await fs.writeFile(wranglerPath, WRANGLER(name))
+    created.push('wrangler.jsonc')
+  }
+
+  // package.json (merge if present — never remove existing fields)
+  const pkgPath = path.join(root, 'package.json')
+  const existingPkg = await readJsonIfExists(pkgPath)
+  const pkg = existingPkg || { name, private: true }
+  pkg.scripts = pkg.scripts || {}
+  if (!pkg.scripts.build) pkg.scripts.build = 'inovus-docs build'
+  if (!pkg.scripts.dev) pkg.scripts.dev = 'inovus-docs dev'
+  pkg.devDependencies = pkg.devDependencies || {}
+  pkg.devDependencies[enginePkg.name] = engineVersion
+  await fs.writeFile(pkgPath, JSON.stringify(pkg, null, 2) + '\n')
+  created.push(existingPkg ? 'package.json (updated)' : 'package.json')
+
+  // .node-version for Cloudflare's build image (Wrangler needs Node 22)
+  const nodeVerPath = path.join(root, '.node-version')
+  if (!(await fileExists(nodeVerPath))) {
+    await fs.writeFile(nodeVerPath, '22\n')
+    created.push('.node-version')
+  }
+
+  await ensureGitignore(root, created)
+
+  // Guarantee a landing page: if the repo has no README/index anywhere, drop a starter.
+  let home = await hasHomePage(root)
+  if (!home && !flags['no-readme']) {
+    const inDocsMode = await fileExists(path.join(root, 'docs'))
+    const rel = inDocsMode ? path.join('docs', 'README.md') : 'README.md'
+    const readmePath = path.join(root, rel)
+    await fs.mkdir(path.dirname(readmePath), { recursive: true })
+    await fs.writeFile(readmePath, starterReadme(title))
+    created.push(rel.split(path.sep).join('/'))
+    home = true
+  }
+
+  return { created, skipped, name, title, visibility, repoUrl, home }
+}

package/src/markdown.js

@@ -42,7 +42,19 @@ export async function createRenderer() {
   md.use(
     await Shiki({
       themes: { light: 'github-light', dark: 'github-dark' },
-      defaultColor: false
+      defaultColor: false,
+      // Real repos use fence languages Shiki doesn't ship (env, console, ...).
+      // Map the common ones, and fall back to plain text instead of crashing the build.
+      fallbackLanguage: 'text',
+      langAlias: {
+        env: 'ini',
+        dotenv: 'ini',
+        conf: 'ini',
+        console: 'bash',
+        shell: 'bash',
+        cmd: 'bat',
+        vue: 'html'
+      }
     })
   )