Skip to content

Format docs front page examples #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anatoly-scherbakov merged 2 commits into from
Jun 22, 2026
Merged

Format docs front page examples #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a2c48d
Add indent parameter to example() macro for nested admonitions
anatoly-scherbakov Jun 21, 2026
01a924e
Pass indent=4 to tabbed front page examples
anatoly-scherbakov Jun 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,49 +22,49 @@ and JSON document stores.
Compacts a JSON-LD document with a context, replacing full IRIs with shorter
terms where possible.

{{ example('compact.py', 'json') }}
{{ example('compact.py', 'json', indent=4) }}

=== "jsonld.expand()"

Expands a compacted JSON-LD document into full IRI-based form and removes the
context.

{{ example('expand.py', 'json') }}
{{ example('expand.py', 'json', indent=4) }}

=== "jsonld.flatten()"

Flattens nested JSON-LD into a top-level node map so each node can be processed
independently.

{{ example('flatten.py', 'json') }}
{{ example('flatten.py', 'json', indent=4) }}

=== "jsonld.frame()"

Frames expanded JSON-LD into a predictable tree shape that matches a supplied
frame.

{{ example('frame.py', 'json') }}
{{ example('frame.py', 'json', indent=4) }}

=== "jsonld.to_rdf()"

Converts a JSON-LD document into RDF statements in a requested serialization
format.

{{ example('to_rdf.py') }}
{{ example('to_rdf.py', indent=4) }}

=== "jsonld.from_rdf()"

Converts RDF statements into JSON-LD so the data can be processed with the
JSON-LD API.

{{ example('from_rdf.py', 'json') }}
{{ example('from_rdf.py', 'json', indent=4) }}

=== "jsonld.normalize()"

Normalizes JSON-LD into canonical RDF statements for stable comparison,
hashing, or signing.

{{ example('normalize.py') }}
{{ example('normalize.py', indent=4) }}

## :fontawesome-solid-people-line: Maintainers

Expand Down
6 changes: 4 additions & 2 deletions docs_macros.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ def skipped_tests_table():
return '\n'.join(rows)

@env.macro
def example(name, output_syntax=None):
def example(name, output_syntax=None, indent=0):
path = _example_path(name)
source = path.read_text()
result = subprocess.run(
Expand All @@ -226,5 +226,7 @@ def example(name, output_syntax=None):
f'```python\n{source}```\n\n'
f'```{output_lang} title="Output"\n{result.stdout}```'
)
indented = '\n'.join(f' {line}' for line in body.splitlines())
content_indent = indent + 4
pad = ' ' * content_indent
indented = '\n'.join(f'{pad}{line}' for line in body.splitlines())
return f'!!! example "{title}"\n\n{indented}\n'
Loading