JSDoc: o-techdocs

o-techdocs has a support status of "deprecated". This means that no new features will be added to this component, but security-related bugs will be fixed. We do not recommend using this component in new projects. If you still rely on this component or have concerns, please contact the Origami team.

gistIt

Global Function

Display Gist-it gists

Links

"gistIt" function on Github

permalinks

Global Function

Show permalink markers on headings with an ID

Links

"permalinks" function on Github

reveals

Global Function

Support displaying additional content on clicking reveal links

Links

"reveals" function on Github

tables

Global Function

Wrap tables

Links

"tables" function on Github

hljs

Global Property

Syntax highlighting using highlight.js - https://highlightjs.org/

Links

"hljs" constant on Github

Status

Switch component view Version

GitHub: o-techdocs

Install o-techdocs

If using the Build Service, add o-techdocs@^7.0.13 to your script and link tags.

If using the npm package manager for a Manual Build, run npm install --save-peer "@financial-times/o-techdocs@^7.0.13".

Help & Support

o-techdocs is maintained directly by the Origami team. If you have any questions about o-techdocs or Origami in general, we are happy to help. 😊

Slack: #ft-origami
Email: origami.support@ft.com

Feedback / Issues

To report a bug or request features please create an issue on Github. For support or general feedback please get in touch 😊

Slack: #ft-origami
Email: origami.support@ft.com