create-vault-cms 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-2026 David V. Kimball
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# Vault CMS
+
+Use [Obsidian](https://obsidian.md) as a content management system for your [Astro](https://astro.build) website.
+
+![Vault CMS cover with Obsidian and Astro logos at the bottom.](https://github.com/user-attachments/assets/fb5d8368-71dd-4bf8-8851-36ada6d4f530)
+
+
+## Video Guide
+
+📺 [Video Guide](https://youtu.be/dSm8aLPdVz0)
+
+## Features 
+
+- Easy integration into Astro website projects
+- **Auto-detection** of your Astro theme and content structure
+- Preconfigured plugins, hotkeys and settings optimized for Astro workflows
+- CMS-like homepage using Obsidian Bases
+- Works with any Astro theme by automatically detecting content types and frontmatter properties
+- Optional instant-publish option via the Git plugin
+
+![Vault CMS Showcase.](https://github.com/user-attachments/assets/0d1ea89e-9d6b-40b1-944d-cfe6143e222e)
+
+> [!NOTE]
+> Preconfigured vaults for [Slate](https://github.com/SlateDesign/slate-blog), [Chiri](https://github.com/the3ash/astro-chiri), and [Starlight](https://github.com/withastro/starlight) have moved to the [Presets](https://github.com/davidvkimball/vault-cms-presets) repo. To see Vault CMS combined with an Astro site specifically designed with it in mind, check out my theme [Astro Modular](https://github.com/davidvkimball/astro-modular).
+
+## Installation Guide
+
+1. Clone or install your Astro theme of choice.
+2. Clone or download a zip of this repo.
+3. Copy the contents of the `Starter Vault` folder into your Astro project. **Recommended location:** `src/content` folder, but it can be placed at the level of `src/content` or higher (like the project root).
+4. Open Obsidian and select the "Open folder as vault" option, and select the folder containing the `.obsidian` directory.
+5. The Vault CMS plugin will automatically detect your Astro project structure and guide you through setup via a wizard.
+
+### Starter Vault vs Theme Examples
+
+- **`Starter Vault`**: This is the adaptive vault that works with any Astro theme. It automatically detects your theme's structure and configures itself accordingly. This is what you should copy into your project.
+
+- **`Theme Examples`**: This folder contains preconfigured vault examples for specific Astro themes (Slate, Chiri, Starlight). These serve as reference examples showing how Vault CMS can be configured for particular themes. You don't need to use these unless you want to see theme-specific configurations.
+
+### Using Theme Examples
+
+If you're using one of the supported themes (Slate, Chiri, or Starlight) and want to use a preconfigured vault example instead of the adaptive Starter Vault:
+
+1. Navigate to the `Theme Examples` folder and find your theme's folder (e.g., `Slate`, `Chiri`, or `Starlight`).
+2. **Copy the CONTENTS** of that theme folder (not the folder itself) into your Astro project's `src/content` folder.
+   - ⚠️ **Important**: Copy the files and folders inside the theme folder, not the theme folder itself. For example, if using Slate, copy the contents of `Theme Examples/Slate/` (like `_bases/`, `post/`, etc.) into `src/content/`, not the `Slate` folder. (Note: `_bases` is the new standard, but `bases` is still supported for backwards compatibility).
+3. Open Obsidian and select "Open folder as vault", then select your `src/content` folder (or the folder containing the `.obsidian` directory).
+4. The vault should already be preconfigured for your theme.
+
+> [!TIP]
+> If you're unsure which to use, start with the **Starter Vault** - it will automatically adapt to your theme. Use the Theme Examples only if you want to see a preconfigured setup for a specific theme.
+
+## How Auto-Detection Works
+
+Vault CMS automatically detects and configures itself based on your Astro project:
+
+- **Project Detection**: Automatically finds your Astro project by locating `astro.config.mjs`, `astro.config.ts`, or other Astro config files
+- **Content Type Detection**: Scans your content folders (like `posts`, `pages`, `docs`, etc.) and automatically identifies them as content types
+- **Frontmatter Analysis**: Analyzes existing content files to detect frontmatter properties (title, date, description, etc.) and configures the plugin accordingly
+- **Theme Adaptation**: Adapts to your Astro theme's specific quirks and requirements automatically
+
+When you first open the vault, a setup wizard will guide you through the configuration process. The wizard uses the auto-detected information to pre-populate settings, making setup quick and easy. You can always run the wizard again later by using the "Open Setup Wizard" command.
+
+### Recommended .gitignore
+
+Add the following to your Astro project's `.gitignore` file:
+```
+# Obsidian workspace files
+**/.obsidian/workspace.json
+**/.obsidian/workspace-mobile.json
+```
+This prevents conflicts between multiple devices.

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "create-vault-cms",
+  "version": "1.0.0",
+  "description": "Installer for Vault CMS",
+  "main": "src/cli.js",
+  "bin": {
+    "create-vault-cms": "src/cli.js"
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/davidvkimball/vault-cms.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "bugs": {
+    "url": "https://github.com/davidvkimball/vault-cms/issues"
+  },
+  "homepage": "https://github.com/davidvkimball/vault-cms#readme",
+  "dependencies": {
+    "commander": "^14.0.2",
+    "fs-extra": "^11.3.3"
+  }
+}

package/src/cli.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+
+const { Command } = require('commander');
+const fs = require('fs-extra');
+const path = require('path');
+const { execSync } = require('child_process');
+
+const program = new Command();
+
+program
+  .name('create-vault-cms')
+  .description('Official installer for Vault CMS')
+  .version('1.0.0');
+
+program
+  .argument('[target]', 'target directory', '.')
+  .option('-t, --template <name>', 'template to use (from vault-cms-presets)')
+  .action(async (target, options) => {
+    const targetDir = path.resolve(target);
+    const tempDir = path.join(targetDir, '.vault-cms-temp');
+    
+    const repoUrl = options.template 
+      ? 'https://github.com/davidvkimball/vault-cms-presets.git'
+      : 'https://github.com/davidvkimball/vault-cms.git';
+
+    console.log(`🚀 Installing Vault CMS${options.template ? ` (template: ${options.template})` : ''}...`);
+
+    try {
+      // 1. Download
+      console.log('  📦 Downloading files...');
+      execSync(`git clone --depth 1 ${repoUrl} "${tempDir}"`, { stdio: 'ignore' });
+
+      // 2. Determine source path
+      const sourcePath = options.template ? path.join(tempDir, options.template) : tempDir;
+      
+      if (!(await fs.pathExists(sourcePath))) {
+        throw new Error(`Template "${options.template}" not found in presets repository.`);
+      }
+
+      // 3. Define what to keep
+      const toKeep = ['_bases', '.obsidian', 'README.md'];
+      
+      // 4. Move selected files
+      await fs.ensureDir(targetDir);
+      for (const item of toKeep) {
+        const src = path.join(sourcePath, item);
+        const dest = path.join(targetDir, item);
+        
+        if (await fs.pathExists(src)) {
+          await fs.copy(src, dest);
+          console.log(`  ✓ Added ${item}`);
+        }
+      }
+
+      // 5. Update .gitignore
+      const gitignorePath = path.join(targetDir, '.gitignore');
+      const ignores = '\n# Vault CMS / Obsidian\n.obsidian/workspace.json\n.obsidian/workspace-mobile.json\n.ref/\n';
+      
+      if (await fs.pathExists(gitignorePath)) {
+        const content = await fs.readFile(gitignorePath, 'utf8');
+        if (!content.includes('.obsidian/workspace.json')) {
+          await fs.appendFile(gitignorePath, ignores);
+          console.log('  ✓ Updated .gitignore');
+        }
+      } else {
+        await fs.writeFile(gitignorePath, ignores.trim() + '\n');
+        console.log('  ✓ Created .gitignore');
+      }
+
+      // 6. Cleanup
+      await fs.remove(tempDir);
+
+      console.log('\n✨ Vault CMS is ready!');
+    } catch (err) {
+      console.error('\n❌ Installation failed:', err.message);
+      if (await fs.pathExists(tempDir)) await fs.remove(tempDir);
+      process.exit(1);
+    }
+  });
+
+program.parse();