Writing Codewars Docs
The Codewars Docs is built with Docusaurus, and the docs are written in Markdown. Each page has "Edit this page" link that allows you to contribute on GitHub.
Plain Markdown is great for writing, but sometimes we need extra features to make the docs more helpful. Docusaurus provides some Markdown extensions, and has support for MDX to extend Markdown with React components.
This page summarizes the features we use, and is also used to test the styling. See Docusaurus docs for more details.
Admonitions#
Use the following syntax to add admonitions:
type is required. title is optional and defaults to uppercased type.
Types#
note
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation.
tip
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation.
info
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation.
warning
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation.
caution
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation.