@janga/norna 0.7.3 → 0.7.4

package/starters/project/site/content.md

@@ -1,88 +1,128 @@
 ---
-title: Project Name
-description: A concise project site for an open source tool, library, or CLI.
+title: Your project
+description: A compact project site starter for an open source developer tool.
 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: why
+  - id: good-fit
   - id: next
+  - id: license
 ---
 
-## Project Name keeps project workflows predictable {#intro}
+## `<Your project> - <short value proposition>` {#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.
+Describe the project in one short, concrete phrase. Focus on what it helps the
+user accomplish rather than implementation details.
 
-## Links {#links}
+> Example: **Checkline - keep project checks simple.**
 
-- [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)
+`<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
-npm install project-name
+<install command>
 ```
 
-Project Name supports current Node.js releases and works in local development,
-CI jobs, and small publishing workflows.
+> 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
-project-name check ./src --format summary
+<main command or minimal usage example>
 ```
 
-```js
-import { checkProject } from 'project-name';
+> Example:
+>
+> ```sh
+> npx checkline
+> ```
 
-const report = await checkProject({
-	input: './src',
-	format: 'summary',
-});
+If a programmatic API is central to the project, a similarly small API example
+may also be shown.
 
-console.log(report.status);
-```
+## 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".
 
-Use the CLI for everyday checks and the API when the same behavior belongs
-inside a larger build script.
+### `<Primary benefit>`
 
-## Features {#features}
+Explain the benefit in one or two sentences.
 
-### Simple inputs
+> Example:
+>
+> ### Fits existing workflows
+>
+> Use Checkline from the command line, project scripts, or automated workflows
+> without introducing a separate service.
 
-The project works with ordinary files and predictable commands.
+### `<Secondary benefit>`
 
-### Scriptable results
+Explain another important property or advantage.
 
-The CLI prints human-readable summaries while the API returns structured data
-for automation.
+> Example:
+>
+> ### Configuration stays with the project
+>
+> Keep configuration alongside the rest of the source files so changes remain
+> visible and versioned.
 
-### Small surface area
+Add a third benefit only when it adds useful information.
 
-There are only a few concepts to learn, so the project stays easy to adopt and
-easy to replace.
+## Good fit for {#good-fit}
 
-## When to use it {#when-to-use}
+Help visitors decide whether the project matches their needs. Describe a few
+realistic situations or workflows rather than repeating the feature list.
 
-- 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.
+> 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}
 
-Read the [guide](/guide/) for configuration options and a longer example, or
-open the repository to inspect the implementation.
+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/routes/guide/route-content.md

@@ -1,58 +1,85 @@
 ---
 title: Guide
-description: Learn the basic Project Name workflow.
+description: Adapt this compact guide for normal project use.
 navigation:
   label: Guide
   order: 10
 sections:
   - id: quickstart
   - id: configuration
-  - id: api
+  - id: usage
+  - id: topic
 ---
 
 ## Quickstart {#quickstart}
 
-Install the package and run the default check against a source directory:
+Show the shortest path from installation to a useful result.
 
 ```sh
-npm install project-name
-npx project-name check ./src
+<install command>
+<first useful command>
 ```
 
-The command exits with a non-zero status when it finds an issue, so it can run
-unchanged in local scripts and CI jobs.
+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}
 
-Project Name looks for a project config file at the repository root:
+Include this section only if configuration is relevant. Explain when
+configuration is needed and show the smallest realistic example.
 
 ```js
 export default {
-	include: ['src', 'scripts'],
-	reporter: 'summary',
+	// project-specific options
 };
 ```
 
-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.
+If the project works well without configuration, say so.
 
-## API {#api}
+> Example: Checkline can run without configuration. Add a config file only when
+> the default paths or command behavior need to change.
 
-Use the API when checks need to be part of another tool:
+## Using `<Your project>` {#usage}
 
-```js
-import { checkProject } from 'project-name';
+Show one slightly more complete example of the normal workflow. The purpose is
+to demonstrate typical use, not every available command or option.
 
-const report = await checkProject({
-	input: './src',
-	reporter: 'json',
-});
+> Example: A project might keep the command in `package.json`:
 
-if (!report.ok) {
-	process.exitCode = 1;
+```json
+{
+  "scripts": {
+    "check": "checkline"
+  }
 }
 ```
 
-The API returns structured results so callers can decide whether to print a
-summary, write a report file, or fail a build.
+```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

@@ -2,8 +2,36 @@
 # 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: "#101314"
+  backgroundColor: "#001314"
   textColor: "#f6f1e8"
   inlineStyles:
     accent: