Local References

You can turn parts of a code snippet into links to internal or external pages.To do that, define references in a CSV file, using a two column format: expression, link . constructor, https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/constructor usefulAction, flow/footer :include-file: file-name.js {referencesPath: "references/references-demo.csv"} class JsClass { constructor() { usefulAction() } } export default JsClass

Global References

Add references to references.csv if you want all your code snippets to use the same references. fapi.book, example-references/api#book fapi.query, example-references/api#query import * as fapi from 'flight-api' function bookFlight(flightInfo) { const confirmation = fapi.book(flightInfo) //... } function flightStatus(id) { const fullStatus = fapi.query(id) return fullStatus.shortStatus }

Inlined Code

snippets/inlined-code-snippets Inlined code is automatically converted into a link if its content matches one of the global references entries: Use `fapi.book` to book a flight. Use fapi.book to book a flight.