Documentation
Package items
Text formatting
This is bold text. This is also bold text. This is italic text. This is also italic text. This is bold italic text. Also this is rendered as bold & italic. This is strikethrough text. This is also strikethrough text. x2 renders as superscript text. It is rendered as x2.
Block formatting
Setext heading
- This appears as a 1st list item.
- This appears as a second list item.
- Unordered list item number 1
- Unordered list item number 2
Special formatting
Class is a type reference. Class is how it renders. [1] links to the official Lua reference manual. The Markdown syntax for this is: [lua.org https://www.lua.org/manual/5.1/index.html]. Class:method is wrapped in backticks to produce the code tag. Class:method is how it renders. renders like 102 using the math tag. is how it renders. The <chem>H_2O</chem> tag works too. It renders as H2O in the MediaWiki parser. The {{t}} module is usable for {{sandbox}}ing template usage.
-- @topic markdown
--- @section Text formatting
--
-- @description
-- '''This''' is bold text.
-- **This** is also bold text.
--
-- ''This'' is italic text.
-- *This* is also italic text.
--
-- '''''This''''' is bold italic text.
-- Also ***this*** is rendered as bold & italic.
--
-- <del>This</del> is strikethrough text.
-- ~~This~~ is also strikethrough text.
--
-- *x<sup>2</sup>* renders as superscript text.
-- It is rendered as <i>x<sup>2</sup></i>.
--- @section Block formatting
--
-- @description
-- #### Setext heading ####
--
-- # This appears as a 1st list item.
-- # This appears as a second list item.
--
-- * Unordered list item number 1
-- * Unordered list item number 2
--- @section Special formatting
--
-- @description
-- @{Class} is a type reference.
-- <code>[[#Class|Class]]</code> is how it renders.
--
-- {@link https://www.lua.org/manual/5.1/index.html} links
-- to the official Lua reference manual. The Markdown syntax for
-- this is: [https://www.lua.org/manual/5.1/index.html](lua.org).
--
-- `Class:method` is wrapped in backticks to produce the `code` tag.
-- <code>Class:method</code> is how it renders.
--
-- $$10^2$$ renders like 10<sup>2</sup> using the `math` tag.
-- <math display="inline">10^2</math> is how it renders.
--
-- The `<chem>H_2O</chem>` tag works too.
-- It renders as H<sub>2</sub>O in the MediaWiki parser.
--
-- The {{t|t}} module is usable for {{t|sandbox}}ing template usage.
-- @pragma box false
-- @pragma card false