Skip to content

Commit e2d78fd

Browse files
committed
feat(docs): add preview and sharing documentation, including local preview mode and guide sharing workflow
1 parent d606ab6 commit e2d78fd

14 files changed

Lines changed: 1122 additions & 637 deletions

src/en/posts/docs/ageratum/01-getting-started.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,21 @@ found.
8787
/ageratum <namespace> # Opens <namespace>:ageratum/<lang>/index.md
8888
/ageratum <namespace> <file> # Opens <namespace>:ageratum/<lang>/<file>.md
8989
/ageratum <namespace> <dir>/<file> # Opens a file in a subdirectory
90+
/ageratum <namespace> <file> <anchor> # Opens and jumps to an anchor
9091
```
9192

9293
> Both arguments support Tab completion, listing namespaces and files that actually exist in the resource pack.
9394
95+
### Preview Command (Optional)
96+
97+
If `enablePreview = true` is set in `ageratum-client.toml`, you can run:
98+
99+
```
100+
/ageratum preview
101+
```
102+
103+
This reads `<minecraft_dir>/<previewPath>/index.md` (default: `ageratum_preview/index.md`) and is useful for live documentation iteration.
104+
94105
---
95106

96107
## 4. Open from the Server Side

src/en/posts/docs/ageratum/03-markdown-syntax.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ Supported types:
330330
```markdown
331331
<click type="OPEN_URL" data="https://example.com">Click to open</click>
332332
<click type="COPY_TO_CLIPBOARD" data="Text to copy">Click to copy</click>
333-
<click type="SUGGEST_COMMAND" data="/say hello">Click to suggest command</click>
333+
<click type="OPEN_FILE" data="C:/path/to/file.txt">Click to open file</click>
334334
<click type="RUN_COMMAND" data="/ageratum ageratum">Click to run command</click>
335335
```
336336

@@ -340,7 +340,7 @@ Supported types:
340340
|---------------------|---------------|---------------------|
341341
| `OPEN_URL` | Full URL | Open a web page |
342342
| `COPY_TO_CLIPBOARD` | Any text | Copy to clipboard |
343-
| `SUGGEST_COMMAND` | Command text | Fill into chat box |
343+
| `OPEN_FILE` | File path | Open a local file |
344344
| `RUN_COMMAND` | Command text | Execute immediately |
345345

346346
### Combining Styles

0 commit comments

Comments
 (0)