Template:MdCode/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Created page with "{{Documentation subpage}} This template allows you to format text as a one-line code in Markdown style. As you can see, this is not real Markdown, but just a template that a...")
 
Line 23: Line 23:


== Usage ==
== Usage ==
Just insert {{MdCode|outline|<nowiki>{{MdCode|YourText}}</nowiki>}} into the page and replace '''YourText''' with your content to make the one-line code styling work.
Just insert {{MdCode|outline-oneclick|<nowiki>{{MdCode|YourText}}</nowiki>}} into the page and replace '''YourText''' with your content to make the one-line code styling work.


<br>'''Manage Wiki Formatting:'''<br>
<br>'''Manage Wiki Formatting:'''<br>
You can use {{MdCode|outline|<nowiki><nowiki>YourText</nowiki></nowiki>}} to disable processing of various commands that allow the wiki to style your text. Also, it can disable the template style.
You can use {{MdCode|outline-oneclick|<nowiki><nowiki>YourText</nowiki></nowiki>}} to disable processing of various commands that allow the wiki to style your text. Also, it can disable the template style.


<br>'''Switching Styles'''<br>
<br>'''Switching Styles'''<br>
Insert {{MdCode|outline|<nowiki>stylename|</nowiki>}} after {{MdCode|outline|<nowiki>{{MdCode|</nowiki>}} and replace '''stylename''' with the name of an existing style.
Insert {{MdCode|outline-oneclick|<nowiki>stylename|</nowiki>}} after {{MdCode|outline-oneclick|<nowiki>{{MdCode|</nowiki>}} and replace '''stylename''' with the name of an existing style.


== Example ==
== Example ==

Revision as of 06:14, 12 November 2022

Edit-copy.png
This is a documentation subpage for Template:MdCode.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

This template allows you to format text as a one-line code in Markdown style.

As you can see, this is not real Markdown, but just a template that allows you to use similar text format when working on page design.


This template has several styles:

Name Description
default enabled by default, but disabled if other styles are activated
oneclick default style with one click selection
desaturated less saturated version
desaturated-oneclick desaturated style with one click selection
outline less saturated version with outline
outline-oneclick outline style with one click selection

Usage

Just insert {{MdCode|YourText}} into the page and replace YourText with your content to make the one-line code styling work.


Manage Wiki Formatting:
You can use <nowiki>YourText</nowiki> to disable processing of various commands that allow the wiki to style your text. Also, it can disable the template style.


Switching Styles
Insert stylename| after {{MdCode| and replace stylename with the name of an existing style.

Example

{{MdCode|Go to [[Main_Page|Main Page]]}}

{{MdCode|outline|Go to [[Main_Page|Main Page]]}}

Preview

Default: Go to Main Page Go to [[Main_Page|Main Page]] Go to Half-Life: Alyx Half-Life: Alyx Go to {{hla|4}}

Desaturated: Go to Main Page Go to [[Main_Page|Main Page]] Go to Half-Life: Alyx Half-Life: Alyx Go to {{hla|4}}

Outline: Go to Main Page Go to [[Main_Page|Main Page]] Go to Half-Life: Alyx Half-Life: Alyx Go to {{hla|4}}