Reference
v0.0.2
The reference pages list the facts of Mishka Document: the attributes of the blocks that read and list documents, the callouts, examples and version placeholder an author places in a page, the permission names, the JSON:API routes and the plugin events.
Use them to look up a name while you build a page or write a plugin. The pages below show each one with a short summary.
- Blocks that read a document Reference for the doc-section, doc-sidebar, doc-toc and doc-switcher blocks: the attributes they share, their own attributes and defaults.
- Document list and card blocks Reference for doc-workspace-list, doc-section-cards, doc-workspace-card, doc-pager and doc-notice: attributes, defaults and behavior.
- Callouts, examples and the version placeholder Reference for the doc-callout and doc-example components, the preview page, and the placeholder that fills in the version a reader is reading.
- Permission names The six Mishka Document permission names, the admin screens, records and dashboard widgets each one opens, and what setting up needs.
- JSON:API routes Mishka Document JSON:API routes for master admins, site admins and readers, with resource types, access rules and a create example.
- Plugin events The mishka_installer events of Mishka Document: page extras, page source, frame and SEO, admin actions, version clone and detach, and record saves.