@ascribed/cli 0.4.4-next.32 → 0.4.5-next.33
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.4.
|
|
3
|
+
"version": "0.4.5-next.33",
|
|
4
4
|
"description": "A toolchain for documentation written as code. This package installs its command, ascribe.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MPL-2.0",
|
|
@@ -40,10 +40,10 @@
|
|
|
40
40
|
"node": ">=24"
|
|
41
41
|
},
|
|
42
42
|
"optionalDependencies": {
|
|
43
|
-
"@ascribed/cli-darwin-arm64": "0.4.
|
|
44
|
-
"@ascribed/cli-linux-arm64": "0.4.
|
|
45
|
-
"@ascribed/cli-linux-x64": "0.4.
|
|
46
|
-
"@ascribed/cli-win32-x64": "0.4.
|
|
43
|
+
"@ascribed/cli-darwin-arm64": "0.4.5-next.33",
|
|
44
|
+
"@ascribed/cli-linux-arm64": "0.4.5-next.33",
|
|
45
|
+
"@ascribed/cli-linux-x64": "0.4.5-next.33",
|
|
46
|
+
"@ascribed/cli-win32-x64": "0.4.5-next.33"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@types/node": "^24.19.2"
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"publishConfig": {
|
|
52
52
|
"access": "public"
|
|
53
53
|
},
|
|
54
|
-
"gitHead": "
|
|
54
|
+
"gitHead": "887c0a2ef96c103e3d5080c4b61978331ba6726a",
|
|
55
55
|
"scripts": {
|
|
56
56
|
"build": "tsc -p tsconfig.json",
|
|
57
57
|
"typecheck": "tsc --noEmit",
|
package/skills/ascribe/SKILL.md
CHANGED
|
@@ -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.4.
|
|
6
|
+
ascribe-version: "0.4.5-next.33"
|
|
7
7
|
---
|
|
8
8
|
|
|
9
9
|
# Ascribe
|
|
@@ -33,7 +33,7 @@ Each changes nothing, and each takes `--format json`.
|
|
|
33
33
|
- `ascribe model`: what the content model allows: page types and their frontmatter, dimensions, phrases, features, glossary terms, widgets, builds, and sources.
|
|
34
34
|
- `ascribe outline <page>`: a page's title, type, and headings, with the ids links use.
|
|
35
35
|
- `ascribe link <target> --from <page>`: whether a link works from a page, and what to write.
|
|
36
|
-
- `ascribe resolve <page> --build <name>`: a page as one build's readers see it.
|
|
36
|
+
- `ascribe resolve <page> --build <name>`: a page as one build's readers see it. Add `--emit site` to see what a reader of the site gets: the page as the site output gives it to the site, with Ascribe's elements, which [reading the site output](https://ascribed-dev.com/go/reading-site-output/) explains.
|
|
37
37
|
- `ascribe refs <target>`: where a page, a heading (`guides/install.md#configure`), a phrase (`phrase:product`), or another entry is used.
|
|
38
38
|
- `ascribe search "<words>"`: where the pages say something, as their readers read them, with the line to edit for each. It finds what `grep` over the source can't: words a phrase, a fragment, or a snippet puts on a page. Run it before writing a page about a subject, and link to what's there or extend it.
|
|
39
39
|
- `ascribe check --summary`: the problems counted by code and by file, for a project with many; `ascribe check --code <code>` then shows one code's, to fix one rule at a time.
|
|
@@ -14,6 +14,7 @@ A directive is a line that starts with `@`. Each built-in one, with its syntax:
|
|
|
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
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
|
|
16
16
|
- `@summary: <text>` under a heading, or `@summary` on the line above a paragraph: the section's summary, its own text, which the page doesn't show, or the paragraph, which it does
|
|
17
|
+
- `@operation: <spec>#<operationId>`, a link to an operation of an API `[apis]` declares: its method, path, and summary, linked to its reference
|
|
17
18
|
|
|
18
19
|
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"}`.
|
|
19
20
|
|