Use json fence block to render auto formatted json and use extra capabilities described below ```json [{"key1": "value1"}, {"key2": "value2"}] ``` Use json include plugin to read json from an external file [{"key1": "value1"}, {"key2": "value2"}] :include-json: simple.json

Use the parameter to highlight an individual value: ```json {highlightValue: "root[1].key2"} [{"key1": "value1"}, {"key2": "value2"}] ``` Pass multiple values to to highlight more than one leaf value :include-json: book-store.json {highlightValue: ["root.store.book[0].category", "root.store.book[2].category"]} Comma-separated paths specified inside will be highlighted.

Use to specify a file with paths to highlight values. :include-json: book-store.json {highlightValueFile: "book-store-paths.json"}

Use the parameter to highlight keys: ```json {highlightKey: "root[1].key2"} [{"key1": ["value11", "value12"]}, {"key2": ["value21", "value22"]}] ```

Use to specify a file with paths to highlight keys. :include-json: book-store.json {highlightKeyFile: "book-store-paths.json"}

To include only a portion of your document pass https://github.com/json-path/JsonPath Json Path as property: :include-json: book-store.json {include: "$..book[0,1]"}

Use to wrap any JSON and include result into parent object(s) :include-json: book-store.json {encloseInObject: "books.rare", include: "$..book[0,1]"}

Use title parameter to specify a snippet title: :include-json: book-store.json {include: "$..book[0,1]", title: "Books"} Use autoTitle: true to automatically set title to specified file name :include-json: book-store.json {include: "$..book[0,1]", autoTitle: true}

When you specify a title, hover mouse over it to see a clickable anchor.Use anchorId to override auto generated identifier. :include-json: book-store.json {include: "$..book[0,1]", title: "Books", anchorId: "my-books"}

Use readMore to show only first lines of JSON . Optional readMoreVisibleLines can be specified to set the initial number of lines to display :include-json: book-store.json {readMore: true, readMoreVisibleLines: 5}

To hide sub-parts of your JSON use collapsedPaths property. :include-json: book-store.json {collapsedPaths: ['root.store.book']}

To highlight a specific JSON value using paths , in (similar fashion to snippets/snippets-highlighting regular code snippets, you can highlight a line by text matching or by providing a line index. :include-json: book-store.json {highlight: ["category", 2]}

You can turn parts of JSON into links to internal or external pages. :include-json: trader.json { title: "trader", referencesPath: "references/json-references-demo.csv" } trader, example-references/domain#trader transaction, example-references/domain#transaction

Use callouts parameter to attach bullet points with explanation to a json path: markdown :include-json: book-store.json { collapsedPaths: ['root.store.book'], callouts: { "root.store.bicycle.color": "subject of **availability**", "root.store.bicycle.price": "*price* changes daily" }} } }

Use calloutsFile parameter to read callouts from a separate file. Can reduce duplication and allows to generate callouts at runtime. markdown :include-json: book-store.json { collapsedPaths: ['root.store.book'], calloutsFile: "schema-notes.json" } { "root.store.bicycle.color": "subject of **availability**", "root.store.bicycle.price": "*price* changes daily" } CSV format is also supported root.store.bicycle.color, subject of **availability** root.store.bicycle.price, *price* changes daily

Below is an example of using https://github.com/testingisdocumenting/webtau WebTau testing framework to make an HTTP call, extract JSON response and information about asserted fields to highlight. http.get("/weather") { temperature.shouldBe < 100 } http.doc.capture("weather-example") http.doc.capture captures multiple test artifacts into separate files: request/response.json, url.txt, paths.json (validated paths). markdown :include-json: weather-example/response.json { title: "weather response example", highlightValueFile: "weather-example/paths.json" }

All the features above require fully formed JSON. If you need only syntax highlighting use snippets/external-code-snippets include-file plugin :include-file: incomplete.json { "config": { ... } }