Primary Use Case

Imagine your product supports multiple ways of achieving a final result: REST Web CLI Java Python more... You can use tabs to allow your user to choose the method to accomplish the goal covered in the documentation. Tab selections will persist for users and provide streamlined experience. Don't: use tabs as navigation experience. If your user needs both and executed one by one you need to show steps one after the other in proper order. Java Python

Definition

To define multiple tabs we use fenced code block: This will generate a multi-tab widget with plugin content for each tab. JavaScript class JsClass { constructor() { usefulAction(); } } export default JsClass; Java class InternationalPriceService implements PriceService { private static void LongJavaInterfaceNameWithSuperFactory createMegaAbstractFactory(final ExchangeCalendarLongerThanLife calendar) { ... } } Cpp int test = 2; // comment with **important** // information int b = 3; int d = 3; /* * multi line comment * of multi *lines* text */ int e = 5; Selecting a tab will switch all the tabs on every page. ```tabs JavaScript: :include-file: snippets/file-name.js Java: :include-file: snippets/WideCode.java Cpp: :include-cpp: snippets/simple.cpp {entry: 'main', bodyOnly: true} ``` include-

Markdown Per Tab

Any valid Markdown can be used in place of content. A typical use case for installation instructions might be dividing content per language or environment: JavaScript First you need to download WebStorm and then run the following using your terminal $ yarn install $ yarn start Java First you need to download Intellij IDEA and then run the following using your terminal $ mvn install $ mvn exec:exec Cpp First you need to download CLion and then run the following using your terminal $ pwd $ whoamis include- ````tabs JavaScript: First you need to download WebStorm and then run the following using your terminal ```bash $ yarn install $ yarn start ``` Java: First you need to download Intellij IDEA and then run the following using your terminal ```bash $ mvn install $ mvn exec:exec ``` Cpp: First you need to download CLion and then run the following using your terminal ```bash $ pwd $ whoamis ``` ````

Separate Markdown Files

Consider extracting content to separate markup files if content becomes long. Use the plugin to include external content. Each tab will display inlined markdown from specified files. JavaScript First you need to download WebStorm and then run the following using your terminal $ yarn install $ yarn start Java First you need to download Intellij IDEA and then run the following using your terminal $ mvn install $ mvn exec:exec Cpp First you need to download CLion and then run the following using your terminal $ pwd $ whoami include-markdown ```tabs JavaScript: :include-markdown: instructions/javascript-install.md Java: :include-markdown: instructions/java-install.md Cpp: :include-markdown: instructions/cpp-install.md ```

Default Tab

Use to set which tab will be initially active. First Tab is active otherwise. JUnit 4 instructions for JUnit4 JUnit 5 instructions for JUnit5 default: "tab name"

Attention Signs

Use extra space(s) in front of or other attention sign keywords to put attention signs inside a tab. Remember if you put 4+ spaces, your paragraph will become a code snippet. JavaScript Do not: commit node_modules to the repository $ yarn install $ yarn start Java First you need to download Intellij IDEA and then run the following using your terminal Warning: install for the first time may take considerable amount of time $ mvn install $ mvn exec:exec mvn Cpp First you need to download CLion and then run the following using your terminal Question: is C++ awesome or what? $ pwd $ whoamis Note: ````tabs JavaScript: ```bash $ yarn install $ yarn start ``` Avoid: committing node_modules Java: First you need to download Intellij IDEA and then run the following using your terminal ```bash $ mvn install $ mvn exec:exec ``` Warning: `mvn` install for the first time may take considerable amount of time Cpp: First you need to download CLion and then run the following using your terminal ```bash $ pwd $ whoamis ``` Question: is C++ awesome or what? ````