stego-cli 0.1.5 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/.gitignore +1 -0
  2. package/.markdownlint.manuscript.json +8 -0
  3. package/README.md +39 -189
  4. package/dist/stego-cli.js +163 -24
  5. package/package.json +7 -5
  6. package/projects/fiction-example/.markdownlint.json +5 -0
  7. package/projects/fiction-example/.markdownlint.manuscript.json +8 -0
  8. package/projects/{plague-demo → fiction-example}/README.md +5 -5
  9. package/projects/{plague-demo → fiction-example}/manuscript/300-the-hearing.md +1 -13
  10. package/projects/{plague-demo → fiction-example}/package.json +1 -1
  11. package/projects/{plague-demo → fiction-example}/spine/characters.md +4 -0
  12. package/projects/{plague-demo → fiction-example}/spine/locations.md +4 -0
  13. package/projects/{plague-demo → fiction-example}/spine/sources.md +3 -0
  14. package/projects/{plague-demo → fiction-example}/stego-project.json +1 -1
  15. package/projects/stego-docs/README.md +27 -0
  16. package/projects/stego-docs/manuscript/100-what-stego-is.md +56 -0
  17. package/projects/stego-docs/manuscript/200-install-and-initialize.md +68 -0
  18. package/projects/stego-docs/manuscript/300-workspace-layout-and-vscode.md +56 -0
  19. package/projects/stego-docs/manuscript/400-everyday-workflow-and-commands.md +70 -0
  20. package/projects/stego-docs/manuscript/500-project-configuration.md +58 -0
  21. package/projects/stego-docs/manuscript/600-spine-and-browser-workflows.md +55 -0
  22. package/projects/stego-docs/manuscript/700-validation-and-stage-gates.md +53 -0
  23. package/projects/stego-docs/manuscript/800-build-export-and-release-outputs.md +53 -0
  24. package/projects/{docs-demo → stego-docs}/package.json +1 -1
  25. package/projects/stego-docs/spine/commands.md +62 -0
  26. package/projects/stego-docs/spine/concepts.md +72 -0
  27. package/projects/stego-docs/spine/configuration.md +57 -0
  28. package/projects/stego-docs/spine/integrations.md +43 -0
  29. package/projects/stego-docs/spine/workflows.md +48 -0
  30. package/projects/stego-docs/stego-project.json +50 -0
  31. package/docs/conventions.md +0 -182
  32. package/docs/workflow.md +0 -78
  33. package/projects/docs-demo/README.md +0 -20
  34. package/projects/docs-demo/manuscript/100-what-stego-is.md +0 -37
  35. package/projects/docs-demo/manuscript/200-writing-workflow.md +0 -69
  36. package/projects/docs-demo/manuscript/300-quality-gates.md +0 -36
  37. package/projects/docs-demo/manuscript/400-build-and-export.md +0 -42
  38. package/projects/docs-demo/stego-project.json +0 -9
  39. package/projects/plague-demo/.markdownlint.json +0 -4
  40. /package/projects/{docs-demo → fiction-example}/dist/.gitkeep +0 -0
  41. /package/projects/{plague-demo → fiction-example}/manuscript/100-the-commission.md +0 -0
  42. /package/projects/{plague-demo → fiction-example}/manuscript/200-at-the-wards.md +0 -0
  43. /package/projects/{plague-demo → fiction-example}/manuscript/400-the-final-account.md +0 -0
  44. /package/projects/{plague-demo → fiction-example}/notes/style-guide.md +0 -0
  45. /package/projects/{plague-demo → stego-docs}/dist/.gitkeep +0 -0
  46. /package/projects/{docs-demo → stego-docs}/notes/implementation-notes.md +0 -0
  47. /package/projects/{docs-demo → stego-docs}/notes/style-guide.md +0 -0
@@ -1,69 +0,0 @@
1
- ---
2
- status: revise
3
- chapter: 1
4
- chapter_title: Overview
5
- ---
6
-
7
- # Fiction Workflow and Spine Features
8
-
9
- This project does not enable Spine categories, but Stego fully supports them.
10
-
11
- ## How Spine works in Stego
12
-
13
- In fiction projects, `stego-project.json` can define spine categories like:
14
-
15
- - `characters` with prefix `CHAR`
16
- - `locations` with prefix `LOC`
17
- - `sources` with prefix `SRC`
18
-
19
- Each category maps to a markdown file under `spine/`.
20
-
21
- ## Identifier model
22
-
23
- Spine entries use stable identifiers such as:
24
-
25
- - `CHAR-MATTHAEUS`
26
- - `LOC-HOTEL-DIEU`
27
- - `SRC-GALEN`
28
-
29
- Writers can reference these identifiers directly in manuscript metadata and prose.
30
-
31
- ## Sidebar and Spine Browser behavior
32
-
33
- In the Stego VS Code extension, identifiers become interactive:
34
-
35
- - click from manuscript metadata to open Spine Browser context
36
- - browse categories and entries from Browser home
37
- - inspect entry markdown, links, and backlinks
38
- - track references across manuscript and notes
39
-
40
- ## Why this matters for fiction
41
-
42
- Spine structure gives fiction teams a canonical layer for consistency:
43
-
44
- - one source of truth for entities
45
- - traceability from manuscript usage to canonical entry
46
- - faster continuity review during revise/proof stages
47
-
48
-
49
- <!-- stego-comments:start -->
50
-
51
- ### CMT-0001
52
- <!-- meta64: eyJzdGF0dXMiOiJvcGVuIiwiYW5jaG9yIjoicGFyYWdyYXBoIiwicGFyYWdyYXBoX2luZGV4IjoxMywic2lnbmF0dXJlIjoiZm52MWE6MWE2YmJhOWEiLCJleGNlcnB0IjoiIyMgV2h5IHRoaXMgbWF0dGVycyBmb3IgZmljdGlvbiJ9 -->
53
- > _2026-02-20T03:46:52.817Z | mattgold_
54
- >
55
- > test
56
-
57
- ### CMT-0002
58
- <!-- meta64: eyJzdGF0dXMiOiJvcGVuIiwiYW5jaG9yIjoicGFyYWdyYXBoIiwicGFyYWdyYXBoX2luZGV4IjoxMywic2lnbmF0dXJlIjoiZm52MWE6MWE2YmJhOWEiLCJleGNlcnB0IjoiIyMgV2h5IHRoaXMgbWF0dGVycyBmb3IgZmljdGlvbiJ9 -->
59
- > _2026-02-20T03:47:21.646Z | mattgold_
60
- >
61
- > yes yes we knoow
62
-
63
- ### CMT-0003
64
- <!-- meta64: eyJzdGF0dXMiOiJvcGVuIiwiYW5jaG9yIjoicGFyYWdyYXBoIiwicGFyYWdyYXBoX2luZGV4IjoxMywic2lnbmF0dXJlIjoiZm52MWE6MWE2YmJhOWEiLCJleGNlcnB0IjoiIyMgV2h5IHRoaXMgbWF0dGVycyBmb3IgZmljdGlvbiJ9 -->
65
- > _2026-02-20T03:50:27.114Z | mattgold_
66
- >
67
- > test
68
-
69
- <!-- stego-comments:end -->
@@ -1,36 +0,0 @@
1
- ---
2
- status: line-edit
3
- chapter: 2
4
- chapter_title: Quality Pipeline
5
- ---
6
-
7
- # Validation and Stage Gates
8
-
9
- Stego separates baseline validation from stage-specific enforcement.
10
-
11
- ## Baseline validate
12
-
13
- `validate` checks project and manuscript integrity, including:
14
-
15
- - frontmatter parse and metadata structure
16
- - markdown structure and local link integrity
17
- - project and manuscript layout assumptions
18
-
19
- ## Stage gate model
20
-
21
- `check-stage` applies stricter checks as status increases:
22
-
23
- - `draft`: structure-first, low friction
24
- - `revise`: continuity expectations for Spine projects
25
- - `line-edit`: spell-check enabled
26
- - `proof`: markdown lint, spell-check, strict local links
27
- - `final`: same strictness as proof with final-status expectations
28
-
29
- ## File-scoped and project-scoped checks
30
-
31
- Stego supports both:
32
-
33
- - local file checks during active editing
34
- - project-wide stage checks before release
35
-
36
- In the extension UI, local checks run from manuscript status controls, while project checks run from the sidebar header.
@@ -1,42 +0,0 @@
1
- ---
2
- status: line-edit
3
- chapter: 2
4
- chapter_title: Quality Pipeline
5
- ---
6
-
7
- # Build and Export Operations
8
-
9
- Stego keeps authoring and distribution predictable.
10
-
11
- ## Build behavior
12
-
13
- `build` compiles manuscript sources into one output markdown file in `dist/`.
14
-
15
- Use build output for:
16
-
17
- - full-read review passes
18
- - stakeholder circulation
19
- - archival snapshots of a known state
20
-
21
- ## Export formats
22
-
23
- `export` supports:
24
-
25
- - `md`
26
- - `docx`
27
- - `pdf`
28
- - `epub`
29
-
30
- `docx`, `pdf`, and `epub` require `pandoc`. `pdf` also requires a PDF engine (for example `tectonic`, `xelatex`, or `pdflatex`).
31
-
32
- ## Recommended release sequence
33
-
34
- 1. Run file checks while drafting.
35
- 2. Run project stage checks before release.
36
- 3. Run build.
37
- 4. Export the target format.
38
- 5. Archive output from `dist/exports` as release artifacts.
39
-
40
- ## Practical note for documentation teams
41
-
42
- You can document Spine features and fiction workflows in a project like this one without enabling Spine categories. That keeps docs simple while still covering the full Stego feature set.
@@ -1,9 +0,0 @@
1
- {
2
- "id": "docs-demo",
3
- "title": "Stego Documentation Demo",
4
- "subtitle": "A business and nonfiction style project without Spine categories",
5
- "author": "Matt Gold",
6
- "requiredMetadata": [
7
- "status"
8
- ]
9
- }
@@ -1,4 +0,0 @@
1
- {
2
- "default": true,
3
- "MD041": false
4
- }