create-mordoc-app 0.0.11 → 1.1.0

package/bin/create.js

@@ -0,0 +1,106 @@
+#!/usr/bin/env node
+
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const { execSync, spawnSync } = require('child_process');
+
+const start = Date.now();
+const projectName = process.argv[2];
+
+if (!projectName) {
+  console.error('Please specify a project name:');
+  console.error('  npx create-mordoc-app my-docs');
+  process.exit(1);
+}
+
+const projectDir = path.resolve(process.cwd(), projectName);
+
+if (fs.existsSync(projectDir)) {
+  console.error(`Error: directory "${projectName}" already exists.`);
+  process.exit(1);
+}
+
+// Fetch latest mordoc version from npm
+let mordocVersion;
+try {
+  mordocVersion = execSync('npm view mordoc version', { encoding: 'utf8' }).trim();
+} catch (e) {
+  console.error('Error: could not fetch mordoc version from npm. Are you online?');
+  process.exit(1);
+}
+
+// Copy template into project directory
+const templateDir = path.join(__dirname, '..', 'template');
+
+function copyDir(src, dest) {
+  fs.mkdirSync(dest, { recursive: true });
+  for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+
+copyDir(templateDir, projectDir);
+
+// Substitute {{projectName}} in config/site.json
+const siteJsonPath = path.join(projectDir, 'config', 'site.json');
+const siteJson = fs.readFileSync(siteJsonPath, 'utf8');
+fs.writeFileSync(siteJsonPath, siteJson.replace(/\{\{projectName\}\}/g, projectName));
+
+// Generate .gitignore
+fs.writeFileSync(
+  path.join(projectDir, '.gitignore'),
+  'node_modules/\ndist/\n'
+);
+
+// Generate package.json
+const pkg = {
+  name: projectName,
+  version: '0.0.1',
+  private: true,
+  scripts: {
+    dev: 'mordoc dev',
+    build: 'mordoc build',
+  },
+  devDependencies: {
+    mordoc: `^${mordocVersion}`,
+  },
+};
+fs.writeFileSync(
+  path.join(projectDir, 'package.json'),
+  JSON.stringify(pkg, null, 2) + '\n'
+);
+
+// Run npm install
+console.log(`\nScaffolding "${projectName}"...`);
+const result = spawnSync('npm', ['install'], {
+  cwd: projectDir,
+  stdio: 'inherit',
+  shell: true,
+});
+
+if (result.status !== 0) {
+  console.error('\nError: npm install failed.');
+  process.exit(1);
+}
+
+const duration = ((Date.now() - start) / 1000).toFixed(1);
+
+console.log(`\n✨ Success! Created ${projectName} in ${duration}s\n`);
+console.log('Your documentation project is ready!\n');
+console.log('Get started with:\n');
+console.log(`  cd ${projectName}\n`);
+console.log('Next steps:\n');
+console.log('  1. Edit your content in content directory');
+console.log('  2. Customize the configuration for your documentation website in config directory');
+console.log('  4. Run npm run dev to preview locally');
+console.log('  5. Run npm run build to generate your site\n');
+console.log('Full documentation at https://mordoc.dev\n');
+console.log('Happy documenting! 📚\n');

package/package.json

@@ -1,20 +1,20 @@
 {
     "name": "create-mordoc-app",
-    "repoitory": {
+    "repository": {
         "type": "git",
         "url": "https://github.com/shiva-varanasi/create-mordoc-app.git"
     },
-    "version": "0.0.11",
+    "version": "1.1.0",
     "description": "Create Mordoc documentation sites with one command",
-    "main": "index.js",
     "bin": {
-        "create-mordoc-app": "./index.js"
+        "create-mordoc-app": "./bin/create.js"
     },
+    "files": [
+        "bin",
+        "template"
+    ],
     "author": "Shiva Varanasi",
     "license": "MIT",
-    "dependencies": {
-        "mordoc": "^0.1.14"
-    },
     "engines": {
         "node": ">=18.0.0"
     }

package/template/config/assets/logo-dark.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 180 40" role="img" aria-label="The Ring of Power">
+  <rect width="180" height="40" rx="10" fill="#1a120d"/>
+  <circle cx="24" cy="20" r="11" fill="none" stroke="#D64518" stroke-width="4"/>
+  <path d="M16 20h16" stroke="#D64518" stroke-width="2" stroke-linecap="round"/>
+  <text x="45" y="25" font-family="Georgia, serif" font-size="17" font-weight="700" fill="#fff7e6">Ring of Power</text>
+</svg>

package/template/config/assets/logo.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 180 40" role="img" aria-label="The Ring of Power">
+  <rect width="180" height="40" rx="10" fill="#ffffff"/>
+  <circle cx="24" cy="20" r="11" fill="none" stroke="#D64518" stroke-width="4"/>
+  <path d="M16 20h16" stroke="#D64518" stroke-width="2" stroke-linecap="round"/>
+  <text x="45" y="25" font-family="Georgia, serif" font-size="17" font-weight="700" fill="#2d1b12">Ring of Power</text>
+</svg>

package/template/config/navigation/sidenav.yaml

@@ -0,0 +1,9 @@
+- label: The Ring
+  expanded: true
+  children:
+    - label: Lore of the Ring
+      path: /lore
+    - label: Wielding the Ring
+      path: /wielding-the-ring
+    - label: Safeguards
+      path: /safeguards

package/template/config/site.json

@@ -0,0 +1,11 @@
+{
+  "name": "The Ring of Power",
+  "description": "A field guide for keepers, scholars, and reluctant bearers of the One Ring.",
+  "baseUrl": "https://ring-of-power.example.com",
+  "defaultLanguage": "en",
+  "metadata": {
+    "ogImage": "/images/ring-og.svg",
+    "ogType": "website",
+    "twitterCard": "summary_large_image"
+  }
+}

package/template/config/styles/theme.css

@@ -0,0 +1,4 @@
+/* Ring of Power theme accents */
+:root {
+  --accent: #D64518; /* ring gold */
+}

package/template/content/en/index.md

@@ -0,0 +1,38 @@
+---
+title: One Ring to Rule Them All
+description: Start here to learn the purpose, promise, and peril of the One Ring.
+layout: landing
+---
+
+{% hero title="One ring" titleAccent="to rule them all" description="A practical field guide for keepers, scholars, and very cautious bearers of the One Ring." background="#120b08" titleColor="#fff7e6" titleAccentColor="#D64518" descriptionColor="#f7d6c6" %}
+{% button path="/lore" %}
+Get started
+{% /button %}
+{% /hero %}
+
+{% section title="Before the Council" background="subtle" %}
+The Ring is small enough to vanish in a closed hand and heavy enough to bend the fate of kingdoms.
+
+This guide gathers the first principles every keeper must know before the Ring is moved, studied, hidden, or entrusted to a bearer.
+
+{% callout type="warning" title="A note from the Council" %}
+Do not put on the Ring to test its nature. The first use is often the first surrender.
+{% /callout %}
+{% /section %}
+
+{% section title="Choose Your Path" %}
+{% cardGrid cols="3" %}
+{% card title="Learn the lore" path="/lore" icon="/images/icons/book.svg" tag="Start here" %}
+Understand where the Ring came from, what it promises, and why wise folk speak of it carefully.
+{% /card %}
+
+{% card title="Wield with care" path="/wielding-the-ring" icon="/images/icons/spark.svg" tag="Guide" %}
+Follow a practical checklist for handling powerful artifacts without losing sight of the road.
+{% /card %}
+
+{% card title="Guard against corruption" path="/safeguards" icon="/images/icons/shield.svg" tag="Safety" %}
+Review warnings, callouts, and rules for anyone trusted with dangerous knowledge.
+{% /card %}
+{% /cardGrid %}
+{% /section %}
+

package/template/content/en/lore.md

@@ -0,0 +1,48 @@
+---
+title: Lore of the Ring
+description: A short history of the One Ring and the forces bound to it.
+---
+
+# Lore of the Ring
+
+The One Ring is not a common trinket, heirloom, or travel charm. It is a ruling artifact, forged to gather power into one small circle of gold.
+
+The Wise agree on one point: anyone who studies the Ring must first understand that it is not passive. It waits, listens, and works upon desire.
+
+![The One Ring resting in shadow](/images/ring-hero.svg)
+
+## What the Ring Is
+
+The Ring carries three qualities every keeper should understand:
+
+- **Power**: it amplifies the will of its bearer.
+- **Secrecy**: it tempts the bearer to hide both action and intent.
+- **Return**: it seeks the hand of its maker.
+
+{% callout type="note" title="Archivist's note" %}
+Descriptions of the Ring are never neutral. Compare accounts from Elves, Men, Hobbits, and former bearers before trusting a single witness.
+{% /callout %}
+
+## Known Names
+
+| Name | Used by | Meaning |
+| --- | --- | --- |
+| The One Ring | Scholars | The master ring among all rings |
+| Isildur's Bane | Gondor | A warning drawn from history |
+| Precious | Former bearers | A sign that attachment has taken root |
+
+## A Brief Timeline
+
+1. The Ring is forged in fire.
+2. It passes from hand to hand through war, loss, and chance.
+3. It is carried into the open again.
+4. The free peoples must decide whether to use it, hide it, or destroy it.
+
+## Related Pages
+
+- Continue with [Wielding the Ring](/wielding-the-ring) for practical handling guidance.
+- Review [Safeguards](/safeguards) before assigning any bearer.
+
+{% callout type="tip" title="Council practice" %}
+When assigning a bearer, send them to the safeguards before the journey begins. Fear is easier to face before the road grows dark.
+{% /callout %}

package/template/content/en/safeguards.md

@@ -0,0 +1,64 @@
+---
+title: Safeguards
+description: Rules and warning signs for keeping the Ring from ruling its keeper.
+---
+
+# Safeguards
+
+The Ring is most dangerous when it feels reasonable. Safeguards turn private judgment into shared practice.
+
+## Core Rules
+
+- Never carry the Ring alone.
+- Never use the Ring to avoid ordinary effort.
+- Never keep the Ring secret from the appointed fellowship.
+- Never confuse possession with ownership.
+
+{% callout type="danger" title="The final rule" %}
+The Ring must not be claimed. If a bearer claims it, all other plans become secondary.
+{% /callout %}
+
+## Warning Signs
+
+Watch for these changes in speech and behavior:
+
+1. The bearer stops naming the mission.
+2. The bearer speaks of the Ring as a gift.
+3. The bearer avoids companions.
+4. The bearer says the Ring can be used "just once".
+
+{% callout type="tip" title="Keep notes" %}
+Short written logs help companions notice slow changes that feel invisible day by day.
+{% /callout %}
+
+## Response Levels
+
+| Level | Sign | Response |
+| --- | --- | --- |
+| Watch | Restlessness near the Ring | Add a companion |
+| Warn | Secret planning | Pause the mission |
+| Intervene | Claiming language | Separate bearer and Ring |
+
+## Example Safeguard Log
+
+```json
+{
+  "day": 17,
+  "bearer": "Frodo",
+  "companion": "Sam",
+  "ringVisible": false,
+  "concern": "bearer requested solitude",
+  "action": "companions stayed close"
+}
+```
+
+## Companion Duties
+
+Companions are not guards alone. They are witnesses, memory-keepers, and the first line of mercy when the Ring begins to speak in the bearer's own voice.
+
+- Keep the bearer in conversation.
+- Record changes in sleep, speech, appetite, and secrecy.
+- Share burdens before resentment turns into isolation.
+- Call for Council review at the first sign of claiming language.
+
+Return to [Wielding the Ring](/wielding-the-ring) when you are ready to continue the procedure.

package/template/content/en/wielding-the-ring.md

@@ -0,0 +1,65 @@
+---
+title: Wielding the Ring
+description: A practical guide for handling the Ring without letting it handle you.
+---
+
+# Wielding the Ring
+
+This guide is issued for emergency stewardship only. To wield the Ring is to invite it into the will, and the will rarely notices the door closing behind it.
+
+## Before You Touch It
+
+Confirm the following before any bearer is appointed:
+
+- The Council has named a clear purpose.
+- The bearer understands the risks.
+- A trusted companion is present.
+- The route away from temptation is shorter than the route toward it.
+
+{% callout type="warning" title="Do not improvise" %}
+The Ring rewards vague intent. Write down the mission before the Ring is moved.
+{% /callout %}
+
+## Handling Procedure
+
+1. Place the Ring on a plain cloth.
+2. Record who is present.
+3. Speak the purpose aloud.
+4. Move the Ring only as far as the plan requires.
+5. Return it to a guarded container.
+
+```txt
+Bearer: Frodo
+Witness: Sam
+Purpose: Carry the Ring toward its unmaking
+Status: Burden accepted, not claimed
+```
+
+## Decision Checklist
+
+Use this checklist before taking action.
+
+| Question | Safe answer |
+| --- | --- |
+| Is the goal specific? | Yes |
+| Is there a witness? | Yes |
+| Is the Ring being used for convenience? | No |
+| Has the bearer asked for help? | Yes |
+
+{% callout type="danger" title="Immediate stop condition" %}
+If the bearer calls the Ring "mine", stop the procedure and move to the safeguards plan.
+{% /callout %}
+
+## Helpful Paths
+
+{% cardGrid cols="2" %}
+{% card title="Review the history" path="/lore" icon="/images/icons/book.svg" %}
+Understanding old failures is the fastest way to avoid repeating them.
+{% /card %}
+
+{% card title="Open the safeguards" path="/safeguards" icon="/images/icons/shield.svg" %}
+Use the safeguards page whenever the Ring begins to feel useful.
+{% /card %}
+{% /cardGrid %}
+
+{% button path="/safeguards" %}Go to safeguards{% /button %}

package/template/public/images/icons/book.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="Book icon">
+  <rect x="14" y="10" width="30" height="44" rx="4" fill="#fff7e6" stroke="#8a4b1f" stroke-width="4"/>
+  <path d="M22 10v44" stroke="#d69e2e" stroke-width="4"/>
+  <path d="M28 22h10M28 31h10" stroke="#8a4b1f" stroke-width="3" stroke-linecap="round"/>
+</svg>

package/template/public/images/icons/shield.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="Shield icon">
+  <path d="M32 6 52 14v15c0 15-8 24-20 29-12-5-20-14-20-29V14l20-8Z" fill="#fff7e6" stroke="#8a4b1f" stroke-width="4" stroke-linejoin="round"/>
+  <path d="M32 12v38M18 27h28" stroke="#d69e2e" stroke-width="4" stroke-linecap="round"/>
+</svg>

package/template/public/images/icons/spark.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="Spark icon">
+  <path d="M32 6 38 25l20 7-20 7-6 19-6-19-20-7 20-7 6-19Z" fill="#f7c948" stroke="#8a4b1f" stroke-width="4" stroke-linejoin="round"/>
+  <circle cx="32" cy="32" r="5" fill="#fff7e6"/>
+</svg>

package/template/public/images/ring-og.svg

@@ -0,0 +1,7 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1200 630" role="img" aria-label="The Ring of Power social preview">
+  <rect width="1200" height="630" fill="#120b08"/>
+  <circle cx="600" cy="315" r="210" fill="none" stroke="#f7c948" stroke-width="42"/>
+  <circle cx="600" cy="315" r="145" fill="none" stroke="#7b341e" stroke-width="14"/>
+  <text x="600" y="120" text-anchor="middle" font-family="Georgia, serif" font-size="56" font-weight="700" fill="#fff7e6">The Ring of Power</text>
+  <text x="600" y="540" text-anchor="middle" font-family="Georgia, serif" font-size="38" fill="#f7c948">One guide to bind them</text>
+</svg>

package/index.js

@@ -1,34 +0,0 @@
-#!/usr/bin/env node
-
-// Import the createApp function from mordoc
-const { createApp } = require('mordoc/dist/cli/create-app');
-
-// Parse command line arguments
-const args = process.argv.slice(2);
-const projectName = args[0];
-
-// Parse options
-const options = {};
-for (let i = 1; i < args.length; i++) {
-  const arg = args[i];
-  if (arg === '--template' && args[i + 1]) {
-    options.template = args[++i];
-  } else if (arg === '--skip-install') {
-    options.skipInstall = true;
-  } else if (arg === '--git') {
-    options.skipGit = false;
-  }
-}
-
-// Check for required project name
-if (!projectName) {
-  console.error('Please specify a project name:');
-  console.error('  npx create-mordoc-app my-docs');
-  process.exit(1);
-}
-
-// Call the createApp function
-createApp(projectName, options).catch(err => {
-  console.error('Error creating project:', err);
-  process.exit(1);
-});