@janga/norna 0.7.2 → 0.7.3

package/starters/project/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "project-site",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "npm run norna:dev --",
+    "norna:dev": "norna dev:local",
+    "norna:dev:lan": "norna dev:lan",
+    "norna:dev:restart": "norna dev:restart",
+    "norna:dev:status": "norna dev:status",
+    "norna:dev:logs": "norna dev:logs",
+    "norna:dev:stop": "norna dev:stop",
+    "norna:check": "npm run norna:config:check && npm run norna:content:check",
+    "norna:config:check": "norna config:check",
+    "norna:content:check": "norna content:check",
+    "norna:sync": "norna content:sync",
+    "norna:typography:presets": "norna typography presets",
+    "norna:typography:show": "norna typography show",
+    "norna:public": "norna site:public",
+    "norna:images": "norna images",
+    "norna:build": "norna build",
+    "norna:build:local": "norna build:local",
+    "norna:deploy": "norna deploy",
+    "norna:deploy:commit": "norna deploy:commit",
+    "norna:deploy:watch": "norna deploy:watch",
+    "norna:doctor": "norna doctor",
+    "norna:preview": "norna preview",
+    "norna:engine:update": "norna engine:update",
+    "norna:engine:version": "norna engine:version",
+    "build": "npm run norna:build"
+  },
+  "dependencies": {
+    "@janga/norna": "0.7.2"
+  }
+}

package/starters/project/site/config.mjs

@@ -0,0 +1,43 @@
+export default {
+	site: {
+		url: 'https://example.com/',
+		basePath: '/',
+	},
+	navigation: {
+		smoothScroll: {
+			enabled: true,
+			minimumDurationMs: 500,
+			maximumDurationMs: 1_100,
+			durationPerPixelMs: 0.18,
+		},
+	},
+	locale: {
+		lang: 'en',
+		labels: {
+			skipToContent: 'Skip to content',
+			siteNavigation: 'Pages',
+			pageNavigation: 'On this page',
+			sectionNavigation: 'Sections',
+			menu: 'Menu',
+			gallery: 'Images',
+		},
+	},
+	footer: {
+		copyrightMessage: '(c) Project contributors.',
+		buildInfo: {
+			enabled: true,
+			text: 'Built',
+			dateTimeFormat: {
+				locale: 'en-GB',
+				timeZone: 'UTC',
+				dateStyle: 'short',
+				timeStyle: 'short',
+			},
+		},
+	},
+	github: {
+		repo: 'owner/project-name',
+		branch: 'main',
+		pagesWorkflow: 'Deploy to GitHub Pages',
+	},
+};

package/starters/project/site/content.md

@@ -0,0 +1,88 @@
+---
+title: Project Name
+description: A concise project site for an open source tool, library, or CLI.
+navigation:
+  label: Home
+  order: 0
+sections:
+  - id: intro
+    presentation:
+      typography:
+        preset: statement
+  - id: links
+  - id: install
+  - id: example
+  - id: features
+  - id: when-to-use
+  - id: next
+---
+
+## Project Name keeps project workflows predictable {#intro}
+
+Project Name is a small open source tool for teams that want repeatable
+results without adding a large platform. It provides one focused command-line
+workflow and a compact JavaScript API for automation.
+
+## Links {#links}
+
+- [GitHub repository](https://github.com/owner/project-name)
+- [Documentation](https://example.com/docs/)
+- [Package](https://www.npmjs.com/package/project-name)
+- [Issue tracker](https://github.com/owner/project-name/issues)
+
+## Install {#install}
+
+```sh
+npm install project-name
+```
+
+Project Name supports current Node.js releases and works in local development,
+CI jobs, and small publishing workflows.
+
+## Example {#example}
+
+```sh
+project-name check ./src --format summary
+```
+
+```js
+import { checkProject } from 'project-name';
+
+const report = await checkProject({
+	input: './src',
+	format: 'summary',
+});
+
+console.log(report.status);
+```
+
+Use the CLI for everyday checks and the API when the same behavior belongs
+inside a larger build script.
+
+## Features {#features}
+
+### Simple inputs
+
+The project works with ordinary files and predictable commands.
+
+### Scriptable results
+
+The CLI prints human-readable summaries while the API returns structured data
+for automation.
+
+### Small surface area
+
+There are only a few concepts to learn, so the project stays easy to adopt and
+easy to replace.
+
+## When to use it {#when-to-use}
+
+- Validate repository conventions before a pull request is reviewed.
+- Reuse the same checks locally and in CI.
+- Add a focused command to an existing project without introducing a service.
+- Expose a small API for downstream tooling.
+
+## Next steps {#next}
+
+Read the [guide](/guide/) for configuration options and a longer example, or
+open the repository to inspect the implementation.

package/starters/project/site/public/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Allow: /

package/starters/project/site/routes/guide/route-content.md

@@ -0,0 +1,58 @@
+---
+title: Guide
+description: Learn the basic Project Name workflow.
+navigation:
+  label: Guide
+  order: 10
+sections:
+  - id: quickstart
+  - id: configuration
+  - id: api
+---
+
+## Quickstart {#quickstart}
+
+Install the package and run the default check against a source directory:
+
+```sh
+npm install project-name
+npx project-name check ./src
+```
+
+The command exits with a non-zero status when it finds an issue, so it can run
+unchanged in local scripts and CI jobs.
+
+## Configuration {#configuration}
+
+Project Name looks for a project config file at the repository root:
+
+```js
+export default {
+	include: ['src', 'scripts'],
+	reporter: 'summary',
+};
+```
+
+Keep configuration small and explicit. Defaults should be good enough for a new
+project, while advanced projects can opt into stricter behavior one setting at a
+time.
+
+## API {#api}
+
+Use the API when checks need to be part of another tool:
+
+```js
+import { checkProject } from 'project-name';
+
+const report = await checkProject({
+	input: './src',
+	reporter: 'json',
+});
+
+if (!report.ok) {
+	process.exitCode = 1;
+}
+```
+
+The API returns structured results so callers can decide whether to print a
+summary, write a report file, or fail a build.

package/starters/project/site/theme.md

@@ -0,0 +1,15 @@
+---
+# Site-wide visual defaults. Remove a value to use the engine default.
+navigation:
+  brand: Project Name
+presentation:
+  backgroundColor: "#101314"
+  textColor: "#f6f1e8"
+  inlineStyles:
+    accent:
+      color: "#8fd3ff"
+    muted:
+      color: "#b8b1a6"
+frame:
+  colors: presentation
+---