Template - Carbon Multi-Page
This template uses IBM's Carbon Design in a multi-page documentation, meaning that each type, query and mutation gets its own dedicated page.
See the template's readme if you use the eject command.
Demo
#
See the latest example of this template on Netlify , along with its configuration file .
Supported options
#
The following options are supported and can be provided via the magidoc.mjs config file.
Markdown support
#
The carbon-multi-page template implements an enhanced markdown syntax, in addition to supporting all the syntax of the Git flavored markdown when using custom pages (see website.options.page in the configuration above).
In brief, the template offers support for tables, code blocks with syntax highlighting for most popular languages, ordered or unordered lists, emojis, etc.
Enhanced Markdown Syntax
#
The template also offers custom components through a special syntax.
Notification
#
A notification is simply a box that will most often contain warnings or information.
Example
Result
Parameters
info , success , warning and error . info Tabs
#
Tabs allow to separate different content into distinct tabs, where only one of the tab is displayed at the time.
Example
Result
This is a first tab.
And here is another one with nested markdown !
Tags
#
Tags are small bubbles containing text, often buzzwords.
Example
Result
Parameters
red ,magenta , purple , blue , cyan , teal , green , gray , cool-gray , warm-gray , high-contrast , outline . outline Introduction
Multiple GraphQL Schemas