@umami/shiso 0.55.0 → 0.61.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to `@umami/shiso` are documented here. This project follows
+[Semantic Versioning](https://semver.org/).
+
+## 0.61.0 - 2026-08-13
+
+### Added
+
+- Initial package release of the upgradeable Shiso framework.
+- Framework-owned development, validation, build, preview, and prerender commands.
+- Project-local generated caches for search, icons, and last-modified metadata.

package/README.md

@@ -1,55 +1,15 @@
 # Shiso
 
-A content layer for [Next.js](https://nextjs.org/).
+Shiso is an open-source documentation framework for Markdown and MDX sites.
 
-[Learn more](https://shiso.umami.is)
+Create a project with `pnpm create shiso-app@latest`, then use the framework
+commands from that project:
 
-## Usage
-
-### 1. Install the package
-
-```shell
-npm install @umami/shiso
-```
-
-### 2. Create page
-
-In your `app` folder, create a folder for the content section you wish to add. In this case we are creating a section for `docs`.
-
-```text
-src
-├── app
-│   └── docs
-│       └── [[...slug]]
-│           └── page.jsx
-```
-
-In the `page.jsx` file, add the following code:
-
-```javascript
-import { Shiso } from '@umami/shiso';
-import { getContent, getContentIds } from '@@umami/shiso/server';
-import config from 'path/to/shiso.config.json';
-
-export async function generateStaticParams() {
-  const ids = await getContentIds('./src/content/docs');
-
-  return ids.map((id: string) => ({
-    id: id.split('/')
-  }));
-}
-
-export default async function Page({ params }: { params: Promise<{ id: string[] }> }) {
-  const content = await getContent(await params, './src/content/docs');
-
-  return <Shiso type="docs" content={content} config={config} />;
-}
+```bash
+pnpm dev
+pnpm build
+pnpm preview
+pnpm check
 ```
 
-### 3. Write content
-
-In the folder you specified, start adding `.mdx` files.
-
-## License
-
-MIT
+Upgrade an existing project with `pnpm update @umami/shiso`.

package/bin/shiso.mjs

@@ -0,0 +1,132 @@
+#!/usr/bin/env node
+
+import { spawnSync } from 'node:child_process';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+import { validateProject } from '../scripts/validate-config.mjs';
+
+const PACKAGE_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
+const VITE_CONFIG = path.join(PACKAGE_ROOT, 'vite.config.ts');
+const VITE_BIN = path.join(
+  path.dirname(fileURLToPath(import.meta.resolve('vite/package.json'))),
+  'bin/vite.js',
+);
+const SSR_ENTRY = path.join(PACKAGE_ROOT, 'src/entry-server.tsx');
+
+const HELP = `
+Usage: shiso <command> [options]
+
+Commands:
+  dev       Start the development server
+  build     Validate and build the static site
+  preview   Preview the production build
+  check     Validate docs.json
+
+Options after dev, build, or preview are passed to Vite.
+`;
+
+function run(command, args, cwd) {
+  const result = spawnSync(command, args, {
+    cwd,
+    env: process.env,
+    stdio: 'inherit',
+  });
+
+  if (result.error) {
+    throw result.error;
+  }
+
+  if (result.status !== 0) {
+    process.exit(result.status ?? 1);
+  }
+}
+
+async function check(projectRoot) {
+  const result = await validateProject({ root: projectRoot });
+
+  if (!result.valid) {
+    console.error('docs.json failed schema validation:\n');
+    for (const error of result.errors) {
+      console.error(`  ${error}`);
+    }
+    process.exit(1);
+  }
+
+  console.log('docs.json is valid.');
+}
+
+async function main() {
+  const [command, ...options] = process.argv.slice(2);
+  const projectRoot = process.cwd();
+
+  if (!command || command === 'help' || command === '--help' || command === '-h') {
+    console.log(HELP.trim());
+    return;
+  }
+
+  if (command === '--version' || command === '-v') {
+    const metadata = JSON.parse(await fs.readFile(path.join(PACKAGE_ROOT, 'package.json'), 'utf8'));
+    console.log(metadata.version);
+    return;
+  }
+
+  if (command === 'check') {
+    await check(projectRoot);
+    return;
+  }
+
+  if (!['dev', 'build', 'preview'].includes(command)) {
+    throw new Error(`Unknown command "${command}". Run shiso --help for usage.`);
+  }
+
+  if (command === 'build') {
+    await check(projectRoot);
+    run(
+      process.execPath,
+      [
+        VITE_BIN,
+        'build',
+        projectRoot,
+        '--config',
+        VITE_CONFIG,
+        ...options,
+        '--outDir',
+        'dist/client',
+        '--emptyOutDir',
+      ],
+      projectRoot,
+    );
+    run(
+      process.execPath,
+      [
+        VITE_BIN,
+        'build',
+        projectRoot,
+        '--config',
+        VITE_CONFIG,
+        ...options,
+        '--ssr',
+        SSR_ENTRY,
+        '--outDir',
+        'dist/server',
+        '--emptyOutDir',
+      ],
+      projectRoot,
+    );
+    run(process.execPath, [path.join(PACKAGE_ROOT, 'scripts/prerender.mjs')], projectRoot);
+    return;
+  }
+
+  run(
+    process.execPath,
+    [VITE_BIN, command, projectRoot, '--config', VITE_CONFIG, ...options],
+    projectRoot,
+  );
+}
+
+main().catch(error => {
+  console.error(`\nError: ${error.message}\n`);
+  process.exitCode = 1;
+});