The commercetools Docs-Kit.

• All content is created as MDX files (markdown with custom React components)
• Preview of the full website while authoring
• Images dynamically optimized
• Blazing fast statically pregenerated sites
• Precisely preconfigured full text search using Algolia docsearch
• Release notes with filtering, topic tagging and RSS feed
• Fully responsive including special layouts for very wide screens (hello devs!)
• Syntax highlighting for many code languages, line highlighting, command prompts
• Many useful custom components that can be directly used in MDX files:
  • Cards (with images, links, icons etc)
  • RSS feeds widget
  • Mermaid diagrams
  • Special mentions (info / warn / error)
  • Multi-language code blocks, code examples from files.
• Re-usable content fragments using MDX transclusion
• Central definition of important constant values in data files
• Custom site-specific components can be centrally injected into MDX (for example interactive features)
• Dynamic API documentation from RAML API specifications (using rmf-codegen for parsing and evaluation)
  • "hybrid" API documentation mode: Full control on what page which endpoint and type is documented in which order, but the actual endpoint and type specs are fully generated. Free form MDX content can be interleaved with API documentation.
  • Resources and Types are autolinked no matter where they are placed in the site. No manual maintenance of API documentation links when refactoring the site structure.
  • scales into very large APIs.

The docs kit follows the convention over configuration principle, especially concerning file naming, file locations and navigation structure. This makes it easy for an author to contribute to any existing documentation website. The kit is configurable nevertheless.

Many components are provided in the standalone @commercetools-docs/ui-kit NPM package and can be used in other website that want to take over the basic design language of the documentation.