Skip to content
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.

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

Improve Example Handling #1

Open
wip-abramson opened this issue Feb 13, 2025 · 1 comment
Open

Improve Example Handling #1

wip-abramson opened this issue Feb 13, 2025 · 1 comment
Assignees

Comments

@wip-abramson
Copy link
Member

When a spec includes an example, e.g. a JSON object, these examples should be autonumbered and easily referenced throughout the spec and externally linked to.

See this example from DID Core using ReSpec - https://www.w3.org/TR/did/upcoming/#example-did-document-with-1-verification-method-type.

The example has:

  • A user provided ID - #example-did-document-with-1-verification-method-type
  • An autogenerated number (Example 24)
  • A title
  • A clickable and copyable link to this example within the example title
  • Clearly styled separation of the example from the rest of the spec text
@KDean-Dolphin
Copy link
Contributor

This is under investigation. There's a Pandoc filter available, but it doesn't play well with npm.

@KDean-Dolphin KDean-Dolphin self-assigned this Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants