You can also make a numbered list like so 1. List items can span multiple paragraphs (if each paragraph starts with the proper indentation) and lists can be nested. Simple bullet lists can be made by starting a line with -, +, or *. The second line will not be seen as a block quote. Note that doxygen requires that you put a space after the (last) > character to avoid false positives, i.e. Lists and code blocks (see below) can appear inside a quote block. Here is an example: # This is a level 1 headerīlock quotes can be created by starting each line with one or more >'s, similar to what is used in text-only emails. You can end a header by any number of #'s. The number of #'s at the start of the line determines the level (up to 6 levels are supported). Note that the exact amount of ='s or -'s is not important as long as there are at least two.Īlternatively, you can use #'s at the start of a line to make a header. Level 1 or 2 headers can be made as the follows This is a level 1 headerĪ header is followed by a line containing only ='s or -'s. Just like Markdown, doxygen supports two types of headers We continue with more text in another paragraph. The section Markdown Extensions discusses the extensions that doxygen supports.įinally section Doxygen specifics discusses some specifics for doxygen's implementation of the Markdown standard.Įven before doxygen had Markdown support it supported the same way of paragraph handling as Markdown: to make a paragraph you just separate consecutive lines of text by one or more blank lines.Īn example: Here is text for one paragraph. Some enhancements were made, for instance PHP Markdown Extra, and GitHub flavored Markdown. The reader is referred to the Markdown site for more details. In the next section the standard Markdown features are briefly discussed. While Markdown's syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown's syntax is the format of plain text email. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions. The design goal for Markdown's formatting syntax is to make it as readable as possible. It is a plain text formatting syntax written by John Gruber, with the following underlying design goal: The content is parsed as YAML.Markdown support was introduced in doxygen version 1.8.0. All content plugins have their own front matter schema, and use the front matter to enrich the default metadata inferred from the content or other configuration.įront matter is provided at the very top of the file, enclosed by three dashes. Front matter įront matter is used to add metadata to your Markdown file. In general, you should only assume the semantics of the markup ( ``` fences become code blocks > becomes quotes, etc.), but not the actual compiled output. The Markdown syntax !(url) only declaratively tells Docusaurus that an image needs to be inserted here, but we may do other things like transforming a file path to URL path, so the generated markup may differ from the output of other Markdown renderers, or a naïve hand-transcription to the equivalent JSX/HTML code. Some may assume a 1-1 correlation between Markdown and HTML, e.g., !(/img/docusaurus.png) will always become, as-is.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |