Scribe supports Markdown (and, by extension, HTML) in a couple of places:
introTextin your config file
- the endpoint title and description in docblocks
- the group name and description in docblocks (
- parameter descriptions in docblocks
Scribe provides some custom HTML and CSS styling that you can use to highlight information in your docs:
The specific styling of these items will depend on your chosen theme. Examples are shown here using the default theme.
You can add badges by using the
badge CSS class, along with one of the
You can add little highlighted warnings and notes using the
<aside> tag and either of the classes
If you don't specify a class,
"notice" is assumed.
You can help your lower-level headings stand out by using the fancy-heading-panel class: