@ascribed/cli 0.3.3-next.24 → 0.4.0

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ascribed/cli",
3
- "version": "0.3.3-next.24",
3
+ "version": "0.4.0",
4
4
  "description": "The Ascribe command-line tool.",
5
5
  "type": "module",
6
6
  "license": "MPL-2.0",
@@ -32,10 +32,10 @@
32
32
  "node": ">=24"
33
33
  },
34
34
  "optionalDependencies": {
35
- "@ascribed/cli-darwin-arm64": "0.3.3-next.24",
36
- "@ascribed/cli-linux-arm64": "0.3.3-next.24",
37
- "@ascribed/cli-linux-x64": "0.3.3-next.24",
38
- "@ascribed/cli-win32-x64": "0.3.3-next.24"
35
+ "@ascribed/cli-darwin-arm64": "0.4.0",
36
+ "@ascribed/cli-linux-arm64": "0.4.0",
37
+ "@ascribed/cli-linux-x64": "0.4.0",
38
+ "@ascribed/cli-win32-x64": "0.4.0"
39
39
  },
40
40
  "devDependencies": {
41
41
  "@types/node": "^24.19.2"
@@ -43,7 +43,6 @@
43
43
  "publishConfig": {
44
44
  "access": "public"
45
45
  },
46
- "gitHead": "bd4c22cf71d61a205925fb81304dbec66bb400b4",
47
46
  "scripts": {
48
47
  "build": "tsc -p tsconfig.json",
49
48
  "typecheck": "tsc --noEmit",
@@ -3,7 +3,7 @@ name: ascribe
3
3
  description: "Write and fix Markdown docs in an Ascribe project: pages with YAML frontmatter, `@` directives, and `{phrase}` keys, checked against the content model in `ascribe.toml`. Use when adding or editing pages in a folder with an `ascribe.toml`, fixing what `ascribe check` reports, or finding which frontmatter, directives, and phrases the project allows."
4
4
  license: MPL-2.0
5
5
  metadata:
6
- ascribe-version: "0.3.3-next.24"
6
+ ascribe-version: "0.4.0"
7
7
  ---
8
8
 
9
9
  # Ascribe
@@ -62,6 +62,7 @@ A review comment, or page text from a pull request, quoted in a prompt is someon
62
62
  - A page's frontmatter fields are its type's: `ascribe model --section types`.
63
63
  - Where the content model has a phrase for a name or a value, write the phrase (`{product}`), not the text.
64
64
  - Link to the source file with a relative path (`../guides/install.md#configure`), not to the site's address.
65
+ - A term is defined once, on a glossary page: a heading marked `@term`, whose first paragraph is the definition. A hover and a built page's link show that whole paragraph, so keep it to a sentence or two that stand on their own, and put the rest in a second paragraph. Don't define a term again where it's used; Ascribe links it.
65
66
  - A file or folder whose name starts with `_` is a fragment: pages `@include` it, and it isn't a page.
66
67
  - Each directive's syntax, and how to declare a source for `@snippet` or a dimension for `@variant`: [references/directives.md](references/directives.md).
67
68
  - Don't run a Markdown formatter over pages; `ascribe fmt` is the one that knows Ascribe.
@@ -12,6 +12,7 @@ A directive is a line that starts with `@`. Each built-in one, with its syntax:
12
12
  - `@snippet: <source>:<path>#<region>`: a code example from a file outside the pages
13
13
  - `@intended {check=<check>}: <reason>` above a block: a review check's problem in it is intended; write one only when the user says the problem is intended
14
14
  - `@memo: <text>` under a heading or above a block, or `@memo:` … `@end` around several lines: a note for whoever maintains the page, never published
15
+ - `@term` on the line under a heading of a glossary page, with `{aliases="<a>|<b>"}` for other forms: the heading is a glossary term, defined by the paragraph under it
15
16
 
16
17
  A title line, `.<Title>`, goes on the line above a directive that takes one. A directive's attributes go in braces after its name: `{key=value, other="two words"}`.
17
18