Skip to content

Commit adbfe3b

Browse files
authored
Tidy up CLI reference generation flow (#3226)
# Description of Changes Some minor cleanups in the flow for regenerating the CLI reference. # API and ABI breaking changes None # Expected complexity level and risk 1 # Testing - [x] Existing CI passes Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
1 parent 413c8cb commit adbfe3b

3 files changed

Lines changed: 3 additions & 8 deletions

File tree

docs/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,8 @@ git push -u origin a-branch-name-that-describes-my-change
3737
> NOTE! If you make a change to `nav.ts` you will have to run `npm run build` to generate a new `docs/nav.js` file.
3838
3939
#### CLI Reference Section
40-
1. Run `cargo run --features markdown-docs -p spacetimedb-cli > cli-reference.md`
41-
42-
We currently don't properly render markdown backticks and bolding that are inside of headers, so do these two manual replacements to make them look okay (these have only been tested on Linux):
43-
```bash
44-
sed -i'' -E 's!^(##) `(.*)`$!\1 \2!' docs/cli-reference.md
45-
sed -i'' -E 's!^(######) \*\*(.*)\*\*$!\1 <b>\2</b>!' docs/cli-reference.md
46-
```
40+
1. Run `cargo run --features markdown-docs -p spacetimedb-cli > docs/cli-reference.md`
41+
2. Run `pnpm format`
4742

4843
### Checking Links
4944

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
},
1919
"scripts": {
2020
"build": "tsc --project ./tsconfig.json && pnpm fix-markdown && prettier --write docs/nav.js",
21-
"fix-markdown": "tools/markdown-fix.mjs docs/cli-reference.md",
21+
"fix-markdown": "scripts/markdown-fix.mjs docs/cli-reference.md",
2222
"format": "pnpm fix-markdown && prettier --write .",
2323
"lint": "prettier . --check --verbose",
2424
"check-links": "tsx scripts/checkLinks.ts"

0 commit comments

Comments
 (0)