@janga/norna 0.7.2 → 0.7.4

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.3"
+  }
+}

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,128 @@
+---
+title: Your project
+description: A compact project site starter for an open source developer tool.
+navigation:
+  label: Home
+  order: 0
+sections:
+  - id: intro
+  - id: links
+  - id: install
+  - id: example
+  - id: why
+  - id: good-fit
+  - id: next
+  - id: license
+---
+
+## `<Your project> - <short value proposition>` {#intro}
+
+Describe the project in one short, concrete phrase. Focus on what it helps the
+user accomplish rather than implementation details.
+
+> Example: **Checkline - keep project checks simple.**
+
+`<Your project>` is an open source `<tool / library / CLI>` for
+`<main purpose>`.
+
+Briefly explain what the project does and who it is for. Optionally mention one
+or two qualities that distinguish it.
+
+> Example: Checkline is a small open source developer tool for running project
+> checks from the command line or automated workflows.
+
+## Project links {#links}
+
+Link to the most useful project resources. Keep only the links that are
+relevant.
+
+- [GitHub repository](https://github.com/owner/project)
+- [Guide / Documentation](/guide/)
+- [Package](https://www.npmjs.com/package/project)
+- [Issue tracker](https://github.com/owner/project/issues)
+
+## Install {#install}
+
+Show the simplest normal way to install the project. Add requirements or other
+explanation only when needed.
+
+```sh
+<install command>
+```
+
+> Example:
+>
+> ```sh
+> npm install checkline
+> ```
+
+## Example {#example}
+
+Show the smallest realistic example that demonstrates the project's main value.
+More advanced usage belongs in the guide.
+
+```sh
+<main command or minimal usage example>
+```
+
+> Example:
+>
+> ```sh
+> npx checkline
+> ```
+
+If a programmatic API is central to the project, a similarly small API example
+may also be shown.
+
+## Why `<Your project>`? {#why}
+
+Give two or three concrete reasons someone might choose the project. Focus on
+meaningful benefits rather than generic claims such as "fast", "powerful", or
+"easy to use".
+
+### `<Primary benefit>`
+
+Explain the benefit in one or two sentences.
+
+> Example:
+>
+> ### Fits existing workflows
+>
+> Use Checkline from the command line, project scripts, or automated workflows
+> without introducing a separate service.
+
+### `<Secondary benefit>`
+
+Explain another important property or advantage.
+
+> Example:
+>
+> ### Configuration stays with the project
+>
+> Keep configuration alongside the rest of the source files so changes remain
+> visible and versioned.
+
+Add a third benefit only when it adds useful information.
+
+## Good fit for {#good-fit}
+
+Help visitors decide whether the project matches their needs. Describe a few
+realistic situations or workflows rather than repeating the feature list.
+
+> Example: Checkline is a good fit for projects that want lightweight checks
+> that can run locally and in automated workflows without adding separate
+> infrastructure.
+
+## Next steps {#next}
+
+Give the visitor a clear path forward.
+
+> Example: Read the [guide](/guide/) to get started, or visit the GitHub
+> repository for source code, issues, and contribution information.
+
+## License {#license}
+
+State the project's license and link to the license file when one exists.
+
+> Example: Checkline is released under the MIT License. See
+> [LICENSE](https://github.com/owner/checkline/blob/main/LICENSE) for details.

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,85 @@
+---
+title: Guide
+description: Adapt this compact guide for normal project use.
+navigation:
+  label: Guide
+  order: 10
+sections:
+  - id: quickstart
+  - id: configuration
+  - id: usage
+  - id: topic
+---
+
+## Quickstart {#quickstart}
+
+Show the shortest path from installation to a useful result.
+
+```sh
+<install command>
+<first useful command>
+```
+
+Briefly explain what happens and what the user should expect.
+
+> Example:
+>
+> ```sh
+> npm install checkline
+> npx checkline
+> ```
+>
+> The command runs the default project check and prints a short result in the
+> terminal.
+
+## Configuration {#configuration}
+
+Include this section only if configuration is relevant. Explain when
+configuration is needed and show the smallest realistic example.
+
+```js
+export default {
+	// project-specific options
+};
+```
+
+If the project works well without configuration, say so.
+
+> Example: Checkline can run without configuration. Add a config file only when
+> the default paths or command behavior need to change.
+
+## Using `<Your project>` {#usage}
+
+Show one slightly more complete example of the normal workflow. The purpose is
+to demonstrate typical use, not every available command or option.
+
+> Example: A project might keep the command in `package.json`:
+
+```json
+{
+  "scripts": {
+    "check": "checkline"
+  }
+}
+```
+
+```sh
+npm run check
+```
+
+## `<API / Commands / Integration / Deployment>` {#topic}
+
+Choose the topic that best fits the project. For a library this may be `API`;
+for a CLI it may be `Commands`; other projects may need `Integration`,
+`Deployment`, or something else.
+
+For example, if a JavaScript API is relevant:
+
+```js
+import { check } from 'checkline';
+
+const result = await check();
+```
+
+Keep the example deliberately small. Detailed reference documentation can live
+elsewhere as the project grows.

package/starters/project/site/theme.md

@@ -0,0 +1,43 @@
+---
+# Site-wide visual defaults. Remove a value to use the engine default.
+navigation:
+  brand: Project Name
+layout:
+  density: compact
+  pageWidth: 1120px
+  gutter:
+    desktop: clamp(1.25rem, 4vw, 3rem)
+    mobile: 1rem
+  spacing:
+    firstSectionTop:
+      desktop: clamp(0.9rem, 1.6vw, 1.5rem)
+      mobile: 0.9rem
+    sectionGap:
+      desktop: clamp(0.8rem, 1.6vw, 1.5rem)
+      mobile: 1rem
+    finalSectionBottom:
+      desktop: clamp(1rem, 2vw, 1.75rem)
+      mobile: 1rem
+gallery:
+  width: 840px
+  maxAvailableWidthPercent:
+    desktop: 100
+    mobile: 100
+  maxAvailableHeightPercent:
+    desktop: 70
+    mobile: 62
+typography:
+  fontFamily: "Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif"
+  preset: text-forward
+  rhythm: compact
+presentation:
+  backgroundColor: "#001314"
+  textColor: "#f6f1e8"
+  inlineStyles:
+    accent:
+      color: "#8fd3ff"
+    muted:
+      color: "#b8b1a6"
+frame:
+  colors: presentation
+---