style_guide.md.cpp - Style recommendations for CodeChat using Markdown

CodeChat’s Sphinx extension also supports Markdown.

Note: this “source file” does not contain any useful, executable code. Instead, it exemplifies literate programming style.

Use

Any file with an extension of .<markdown extension>.<source file extension> will be processed as Markdown; for example, see this file’s name. The <markdown extension> is defined as any key in Sphinx’s source_suffix build configuration file whose value is "markdown". See the Sphinx manual on Markdown for more information. This feature requires the myst_parser extension for Sphinx, as discussed in the previous link.

Syntax

The same syntax rules apply to Markdown; see here for basic Markdown syntax.

Advice

At the present, the author doesn’t use Markdown with CodeChat; however, the information at style_guide.cpp mostly applies. Instead, this file simply serves as an example of using Markdown with CodeChat.