Implement artifact-level render command with Markdown output and update docs
This commit is contained in:
@@ -1,8 +1,7 @@
|
||||
# Examples
|
||||
|
||||
These are small synthetic, copyable example assets for the implemented CLI
|
||||
commands.
|
||||
This directory is the canonical examples home for documentation.
|
||||
commands. This directory is the canonical examples home for documentation.
|
||||
|
||||
## Merge example
|
||||
|
||||
@@ -55,6 +54,25 @@ go run ./cmd/seriatim trim \
|
||||
--keep "1-2"
|
||||
```
|
||||
|
||||
## Render example
|
||||
|
||||
Input artifact:
|
||||
|
||||
- `render/input-intermediate.json`
|
||||
|
||||
Expected Markdown output shape:
|
||||
|
||||
- `render/output-markdown.md`
|
||||
|
||||
Run:
|
||||
|
||||
```sh
|
||||
go run ./cmd/seriatim render \
|
||||
--input-file examples/render/input-intermediate.json \
|
||||
--output-file /tmp/seriatim-example-render.md \
|
||||
--format markdown
|
||||
```
|
||||
|
||||
## YAML rule examples
|
||||
|
||||
- `speakers.yml`
|
||||
|
||||
33
examples/render/input-intermediate.json
Normal file
33
examples/render/input-intermediate.json
Normal file
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"metadata": {
|
||||
"application": "seriatim",
|
||||
"version": "v-test",
|
||||
"output_schema": "seriatim-intermediate"
|
||||
},
|
||||
"segments": [
|
||||
{
|
||||
"id": 1,
|
||||
"start": 1,
|
||||
"end": 4,
|
||||
"speaker": "Eric Rakestraw",
|
||||
"text": "Hello there."
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"start": 5,
|
||||
"end": 8,
|
||||
"speaker": "Mike Brown",
|
||||
"text": "Welcome back, everyone."
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"start": 9,
|
||||
"end": 10,
|
||||
"speaker": "Eric Rakestraw",
|
||||
"text": "Yeah.",
|
||||
"categories": [
|
||||
"backchannel"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
7
examples/render/output-markdown.md
Normal file
7
examples/render/output-markdown.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Transcript
|
||||
|
||||
[00:00:01–00:00:04] **Eric Rakestraw:** Hello there.
|
||||
|
||||
[00:00:05–00:00:08] **Mike Brown:** Welcome back, everyone.
|
||||
|
||||
[00:00:09–00:00:10] **Eric Rakestraw:** *Yeah.*
|
||||
Reference in New Issue
Block a user