Skip to main content

Appendix E: Styles, Standards and Creating Content

Appendix E explains how to set up an editing workflow and revise the How to Set Up a Cardano Stake Pool, Version 2.0 guide.

You can create content for the How to Set Up a Cardano Stake Pool guide using Markdown or HTML. Appendix E also includes a style guide showing you:

  • Guidelines for writing style
  • How to use all available HTML styles
  • Markdown syntax specific to Docusaurus

Setting Up Your Workflow

The How to Set Up a Cardano Stake Pool guide is created using Docusaurus, a project by Meta Open Source designed for building optimized Web sites quickly. Built using Node.js® and React, Docusaurus is platform agnostic.

To edit the Guide, CoinCashew recommends using the Visual Studio Code source code editor.

To set up a workflow for revising the How to Set Up a Cardano Stake Pool guide, you need to:

  • Install Node.js and Docusaurus
  • Download the GitHub repository for the Guide
  • Install and configure the Visual Studio Code editor

Installing Node.js

Node.js is an open-source, cross-platform JavaScript runtime environment that executes JavaScript code outside of a Web browser.

To install Node.js:

  • Using a Web browser, visit the Download Node.js page. In the dropdown fields, select a Node.js Long-Term Support (LTS) version 18.0 or above for your operating system using nvm with npm, and then follow the instructions that the Download page displays.
    OR
    Download a prebuilt Node.js installer for your operating system, then run then installer, and then follow the instructions on screen to complete the installation.

Installing and Starting Docusaurus

The simplest method of installing Docusaurus involves creating a new project Web site using a default template.

To install Docusaurus:

  1. Using a terminal window, navigate to the folder where you want to store Docusaurus project Web sites, such as the How to Set Up a Cardano Stake Pool guide.
  2. To create a new Docusaurus project Web site, type the following command where <WebsiteName> is the name of the new project: npx create-docusaurus@latest <WebsiteName> classic

    Note
    Note

    For example, name the new project test

  3. When prompted to install the create-docusaurus package, type y and then press ENTERto proceed.
  4. When prompted to select a language, select JavaScript and then press ENTER
  5. When the installation completes, to start the development server for the new project Web site, type:
    cd ./<WebsiteName>
    npx docusaurus start

The development server starts, and then compiles the Web site. The development server serves your Web site, allowing you to preview changes as you edit the files. When compiled successfully, your default Web browser opens displaying the Web site at http://localhost:3000

For details on the folders and files comprising a Docusaurus Web site, refer to the Project Structure.

Use the project that you create as a playground to learn how to use Docusaurus.

Note
Note

For more details on using Docusaurus, see the documentation.

To stop the development server:

  1. When you are finished your session editing the Web site, navigate to the terminal window running the development server, and then press CTRL+C
  2. If prompted, confirm that you want to stop the development server.

Downloading and Compiling the Guide

The CardanoSPOGuide GitHub repository stores the source files for the How to Set Up a Cardano Stake Pool, Version 2.0 guide—a fully open-source project fully powered by stake pool operators like you.

To download and compile the Guide:

  1. To install Git, if you are using Linux then type the following commands using a terminal window:
    sudo apt-get update
    sudo apt-get install git
    OR
    If you are using Windows, download a Standalone Installer, then run the EXE file that you downloaded, and then follow the instructions on screen to complete the installation.
  2. To configure Git, using a terminal window type the following commands where <UserName> is your Git user name, and <EmailAddress> is your e-mail address:
    git config --global user.name "<UserName>"
    git config --global user.email "<EmailAddress>"

    Note
    Note

    To display the current user name or e-mail address, type git config --global user.name or git config --global user.email respectively.

  3. Using a Web browser, log in to your GitHub account.
  4. Navigate to the CardanoSPOGuide repository, then click the Fork button, and then scroll down to click the green Create Fork button.
  5. Using a terminal window, navigate to the folder on your computer where you store Docusaurus project Web sites, and then type the following commands where <ForkedRepository> is the URL to the fork of the CardanoSPOGuide repository that you created in step 4:
    git clone <ForkedRepository>
    cd ./CardanoSPOGuide
    npm install
    npm update
    npm audit fix
  6. To start the development server for the Guide, type npx docusaurus start
  7. When you are ready to stop the development server, navigate to the terminal window running the development server, and then press CTRL+C

When revising the How to Set Up a Cardano Stake Pool guide, you need to know about the following folders and files in the Docusaurus project, relative to the root CardanoSPOGuide folder:

  • /assets/—Contains source files for images; scripts; and, snippets that you may use when revising the Guide
  • /docs/—Contains the content files for the Guide
  • /src/css/custom.css—Defines the Cascading Style Sheets (CSS) describing presentation and styling of the Guide
  • /static/img/—Contains image files that the Guide uses

Note
Note

Specifying file paths relative to the root folder of the project is standard for Web sites created using Docusaurus.

For details on creating a pull request to submit content that you create to CoinCashew for publication in the Guide, see the topic Creating a Pull Request from a Fork.

Installing and Configuring Visual Studio Code

Visual Studio Code (VS Code) is a free, lightweight and powerful source code editor developed by Microsoft for Windows, macOS and Linux. VS Code is highly customizable and user friendly, offering features such as syntax highlighting, intelligent code completion and Git integration.

To install and configure VS Code:

  1. Visit Setting Up Visual Studio Code, and then follow the instructions for your platform.
  2. After finishing the installation, open VS Code
  3. In VS Code, click the File menu, then click Open Folder, then navigate to the CardanoSPOGuide folder, and then click Open
  4. To install HTML code snippets for the Guide:
    1. In the Explorer left pane, click to expand the assets/text subfolder, and then click to open the file html-snippets.json
    2. Position the cursor in the html-snippets.json file, then press CTRL+A, and then press CTRL+C to copy the contents of the file.
    3. Click the File menu, then click Preferences, and then click Configure Snippets
    4. In the Select Snippets File field, type HTML, and then press ENTER
    5. In the html.json file that opens, position the cursor where you want to paste snippet definitions, then press CTRL+V, then edit the file as needed, and then press CTRL+S to save the html.json file.
  5. To set the default Language Mode for files having the MDX file name extension to HTML:
    1. Click the File menu, then click Preferences, and then click Settings
    2. In the Search Settings field, type files.associations
    3. In the Files: Associations setting, click the Add Item button. In the Item field type *.mdx, then in the Value field type html, and then click OK

For details on using VS Code to submit content that you create to your fork of the CardanoSPOGuide repository, see the section Staging and Committing Code Changes.

Writing Style Guide

In general, the How to Set Up a Cardano Stake Pool guide follows the Microsoft Writing Style Guide. In particular, you may find the following topics useful:

HTML Style Guide

In the comprehensive sample text below, parentheses contain one of the following to show you how to use each style:

  • HTML tag name (may be nested)
  • CSS .class selector
  • Name of a provided VS Code snippet

Heading 1 (h1)

Paragraph Text (p)—Mauris sed erat ac urna sollicitudin consequat et et ipsum. Ut viverra quis elit eget feugiat. Pellentesque pulvinar placerat ligula, ac rhoncus est dignissim consequat. Suspendisse pellentesque, leo ut blandit tristique, odio mi ultricies mi, eu sodales erat mi sed elit. Donec tincidunt in orci ut condimentum. Etiam eu massa in metus auctor interdum. Proin eleifend fringilla tortor, vitae bibendum augue semper id. Donec et varius massa, at commodo sapien. Nulla lectus dolor, varius vel mollis at, condimentum et nibh. In vulputate in ante non placerat. Fusce bibendum dolor sit amet molestie faucibus.

Fusce eleifend iaculis feugiat. Proin consequat eget orci ac ultrices. Phasellus a sem nec ipsum tristique mattis. Suspendisse id vulputate eros. Mauris bibendum magna id bibendum ornare. Phasellus ultricies posuere est, vitae sagittis tellus. Donec facilisis non purus egestas vestibulum. Sed orci ex, pharetra id sapien sed, mattis scelerisque velit. Nunc ut diam sed nisi dictum tincidunt.

Morbi vulputate elit sapien, a dignissim tortor vulputate eu. Nam imperdiet sapien vulputate, malesuada enim sit amet, venenatis ipsum. Morbi fringilla nunc sit amet iaculis accumsan. Suspendisse ultricies tempus augue, ut vulputate ipsum. Vivamus imperdiet fringilla lectus at porttitor. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec et magna in dolor vulputate pulvinar. Nulla molestie rhoncus rutrum.

Bold, italic and bold italic font weights and styles are available.

Heading 2 (h2)

Quisque vitae lorem suscipit, posuere elit vitae, rutrum enim. Vestibulum ultricies nisi luctus lobortis efficitur. Donec sit amet diam lacinia, faucibus orci vel, euismod mauris. Nunc a massa tincidunt, ornare magna sit amet, tempus mauris. Donec sed suscipit turpis, egestas iaculis quam. Nunc ut mi at mi condimentum tempor. Curabitur eleifend, nulla nec accumsan tincidunt, nisl lorem iaculis ante, sit amet semper massa orci a lectus. Nam justo nibh, scelerisque quis quam non, scelerisque tristique eros. Cras id nisl non turpis sagittis posuere sed ut turpis. Nulla purus diam, imperdiet at aliquam nec, lacinia eu sapien. Proin aliquet mauris egestas nibh pharetra ornare. Praesent ut convallis ipsum.

Note
Note

Note Box (Note Box)—Sed in nisl vel enim malesuada convallis. Vivamus non mauris est. Donec luctus purus vel facilisis convallis. In hac habitasse platea dictumst.

Phasellus in egestas magna, vitae finibus enim. Quisque interdum tortor sit amet lorem condimentum, non gravida ipsum auctor. Aenean ut viverra ligula, ac tincidunt massa. Fusce mollis mauris et congue aliquet. Ut lacinia vehicula turpis eget posuere. Aenean iaculis ac erat id mattis. Sed sit amet dui eu tortor molestie tincidunt.

Note
Note

Fusce lacinia metus nisl, non fermentum justo tempor in. Nulla magna nisi, facilisis et nisl quis, fermentum sagittis felis. Proin iaculis posuere enim et scelerisque. Mauris mattis at eros sit amet pretium. Integer vel interdum dolor, eu eleifend justo. Nam vitae pulvinar nisl. Donec semper sapien nec arcu facilisis pellentesque. Praesent bibendum feugiat purus nec feugiat. Morbi quam est, viverra at molestie vulputate, fringilla sollicitudin metus. Donec at neque iaculis magna interdum viverra. Curabitur ut justo volutpat, congue massa at, vehicula mi. Aliquam vulputate facilisis quam eu imperdiet.

Create new topics in the /docs subfolder using MDX as the file name extension. To create a new topic, use the following template where <TopicTitle> is main heading on the page; <TopicSidebarLabel> labels the topic in the sidebar navigation; <UniqueURLSegmentToTopic> is a unique string appended to the base path for the Web site to create the URL for the topic; <TitleStatus> is a Boolean value (true or false) determining whether or not the title displays at the beginning of the topic; <TOCStatus> is a Boolean value determinig whether or not the table of contents appears in the top right corner of a topic; <SidebarPositionNumber> is an integer where higher numbers appear lower in the order of topics in the sidebar; and, <Description> is a brief summary of the topic that displays in a sidebar category for the topic:

---
title: "<TopicTitle>"
sidebar_label: "<TopicSidebarLabel>"
slug: /<UniqueURLSegmentToTopic>
hide_title: <TitleStatus>
hide_table_of_contents: <TOCStatus>
sidebar_position: <SidebarPositionNumber>
description: "<Description>"
---

import React from 'react';

export function HTMLContent() {

  /* DEFINE MULTILINE STRING CONSTANTS HERE */

  return (
    <div>

      {/* INSERT HTML CONTENT HERE */}

    </div>
  );
}

<HTMLContent />

<!-- INSERT MARKDOWN CONTENT HERE -->

Note
Note

For more details on how to preserve whitespace in code blocks, see the source file for Appendix E, available at the relative path /docs/E‑Styles.mdx

You can create inline code (code) or code blocks (CodeBlock). For example:

Bash
if [ true ]
then
# To escape the reserved backslash (\) character, use a double backslash (\\)
echo "Sample Code" \
| grep -i "code"
fi
JSON
{
"name": "How to Set Up a Cardano Stake Pool",
"parts": [
"I",
"II",
"III",
"IV",
"V"
]
}

Note
Note

Markdown with JavaScript XML (MDX) is whitespace insensitive, even inside pre tags.

Alternately, to display a code block without the option of using syntax highlighting, assign a code block to a multiline string constant—preserving white space—and then reference the constant in a pre tag:

function Code()
{
  Sample Code;
  Sample Code;
  Sample Code;
}

You can import and display any text file:

___ __ __ __ _ ___ __ ____ _ _ ____ _ _
/ __)/ \( )( ( \ / __) / _\ / ___)/ )( \( __)/ )( \
( (__( O ))( / /( (__ / \\___ \) __ ( ) _) \ /\ /
\___)\__/(__)\_)__) \___)\_/\_/(____/\_)(_/(____)(_/\_)

+-------+
| Start |
+---+---+
|
|
|
|
+---v---+
| Stop |
+-------+

Reusable code blocks may use placeholders:

--witness-count {{witness-count}}

Replace placeholders with values in the definition of the HTMLContent function using string manipulation:

var samplePlaceholderAppendixD = samplePlaceholder.replace("{{witness-count}}", "3");

In the following code block, the placeholder is replaced with a value:

--witness-count 3

Here is a hyperlink to an internal page in the Guide. When creating internal links or inserting images in JavaScript XML (JSX), use the useBaseUrl (useBaseUrl) hook to ensure that Docusaurus prepends the baseUrl configured in the docusaurus.config.js file for the project. For example:

import React from 'react';

<!-- Import the useBaseUrl component -->
import useBaseUrl from '@docusaurus/useBaseUrl';

export function HTMLContent() {
return (
<div>

{/* <!-- Creating an internal hyperlink --> */}
<a href={useBaseUrl('/AppendixE')}>Appendix E: Styles, Standards and Creating Content</a>

{/* <!-- Inserting an image using a relative path --> */}
<img src={useBaseUrl('img/CCLogoLarge.png')} alt="CoinCashew.io Logo" />

</div>
);
}

<HTMLContent />

Note
Note

Set the target="_blank" attribute for external hyperlinks only.

Here is a link to a bookmark on the same page in the Guide. When defining bookmarks, use an anchor tag setting an id attribute such as <a id="html-style-guide" /> to ensure that clicking a link to the anchor does not scroll under the fixed header at the top of the page.

In sit amet mauris laoreet, ultricies diam ut, volutpat neque. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Cras facilisis sapien et ante lacinia imperdiet. Nullam condimentum purus non neque porta, malesuada varius nibh rutrum. Nulla maximus at magna eget tincidunt. Donec non porttitor sem. Nam vitae condimentum est. Etiam id faucibus quam, quis aliquet tortor.

Important
Important

Important Box (Important Box)—In MDX files, when importing React components names are case sensitive and the first letter MUST be capital. For example:

Correct
import TestnetNote from '@site/src/components/TestnetNote.js';
<TestnetNote />
Incorrect
import testnetNote from '@site/src/components/TestnetNote.js';
<testnetNote />

Table 1 (Table) provides some HTML entities that you may need when using (JSX).

Table 1 HTML Entities

Character Name

Display Character

HTML Entity

Ampersand

&

&amp;

Left Brace

{

&#123;

Right Brace

}

&#125;

Less Than

<

&lt;

Greater Than

>

&gt;

Quotation Mark

"

&quot;

Apostrophe

'

&apos;

Non-breaking Space

" "

&nbsp;

Non-breaking Hyphen

‑

&#8209;

In sit amet mauris laoreet, ultricies diam ut, volutpat neque.

Ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Cras facilisis sapien et ante lacinia imperdiet.

Curabitur fringilla tristique rutrum.

Morbi sit amet blandit ipsum.

Phasellus sed luctus nunc. Integer hendrerit augue mi, gravida cursus leo vestibulum in.

Ut eget justo ut erat aliquet semper. Praesent tristique, leo feugiat mollis posuere, lorem dui auctor justo, in pulvinar augue turpis at nisl. Nullam blandit metus at lorem dignissim, suscipit imperdiet tellus euismod. Aenean euismod sapien ut est hendrerit accumsan. Vestibulum vitae volutpat mi.

Nulla ullamcorper sed ante ornare vehicula. Etiam gravida convallis sem quis egestas. Duis convallis mi lobortis odio accumsan elementum. Praesent id pulvinar tortor. Etiam volutpat velit a auctor blandit. Fusce dictum aliquam elementum. Nam iaculis lacus sed odio finibus, ac interdum ipsum feugiat. Cras ac leo et arcu condimentum vehicula.

Here is an Unordered List (ul):

  • List Item (li)—Praesent sapien libero, commodo vitae iaculis eget, pretium vel ligula. Suspendisse pellentesque eleifend porta. Curabitur posuere a ex a lobortis. Cras rhoncus non tortor condimentum pretium.
  • Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
  • Ipsum dolor sit amet, consectetur adipiscing elit. Cras in eleifend ante, vitae placerat arcu. Duis pharetra mattis fringilla. Quisque consequat fermentum bibendum. Donec commodo ipsum ut justo porta aliquet. Vestibulum a sagittis leo, a convallis elit. Pellentesque elementum placerat arcu eu tristique. Duis in risus egestas dolor consectetur lobortis non vestibulum sem. Here is a second-level Unordered List (ul):
    • List Item (li)
    • Nulla commodo nunc elit, id hendrerit arcu fringilla at. Nullam venenatis massa ut orci iaculis, eu ultrices dolor vulputate. Maecenas vestibulum arcu nec eros viverra, eu finibus risus suscipit. Nullam arcu lacus, auctor et nisl at, posuere pharetra lorem. Nam finibus lobortis ligula vel euismod. Donec nec erat lobortis, pharetra urna quis, dignissim dui. Curabitur lacus mauris, cursus aliquet egestas id, fringilla eget diam.

      Note
      Note

      Integer cursus ornare condimentum.

    • Vivamus convallis massa at interdum facilisis. In vehicula nibh a turpis lacinia, non pretium lorem mollis. Aliquam iaculis metus dolor, ut ultrices nibh tincidunt ut. Here is a third-level Unordered List (ul):
      • List Item (li)—In et maximus turpis, at consectetur orci. Etiam vestibulum, enim et pulvinar vulputate, orci erat dictum arcu, et dictum nulla magna vel risus. Quisque lacinia, elit ut convallis ultrices, tellus dolor iaculis erat, vel tristique ipsum erat id sapien. Praesent ac varius sem, eu interdum lacus.
      • Aliquam condimentum ipsum vel orci imperdiet, vitae suscipit purus tincidunt. Nulla porta id magna tristique sollicitudin. Etiam in viverra magna.
    • Donec malesuada, orci id placerat tempus, urna justo venenatis quam, eget sagittis nulla est ut odio. Vivamus sed feugiat nisi. In hac habitasse platea dictumst.
  • Morbi mollis lectus eget erat imperdiet commodo. Vivamus fringilla interdum faucibus. Phasellus faucibus massa felis, sit amet ultrices nisi accumsan eget.

Heading 3 (h3)

Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Cras lectus massa, facilisis ac maximus a, interdum sit amet elit. In egestas urna et purus porta volutpat.

Heading 4 (h4)

Vestibulum faucibus neque nec egestas sagittis. Curabitur felis tortor, dignissim sed ipsum in, dignissim pharetra nulla. Maecenas ac lacus eu orci suscipit volutpat. Curabitur sed urna tristique, varius eros sit amet, imperdiet purus. Etiam in ante in erat bibendum hendrerit. Curabitur eu erat blandit, scelerisque ipsum id, faucibus nunc. Integer dignissim nibh eget turpis ultrices, quis vulputate massa vehicula. Ut a ultricies mi. Maecenas vulputate felis id ipsum accumsan congue. Aenean nec purus a odio pellentesque aliquam sed a nulla.

Credit
Credit

Use the Credit Box (Credit Box) to recognize a contributor to the Guide. Integer vitae pharetra augue. Phasellus sit amet risus ac velit porttitor ornare. Interdum et malesuada fames ac ante ipsum primis in faucibus.

Morbi vulputate elit sapien, a dignissim tortor vulputate eu. Nam imperdiet sapien vulputate, malesuada enim sit amet, venenatis ipsum. Morbi fringilla nunc sit amet iaculis accumsan. Suspendisse ultricies tempus augue, ut vulputate ipsum. Vivamus imperdiet fringilla lectus at porttitor. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec et magna in dolor vulputate pulvinar. Nulla molestie rhoncus rutrum.

Figure 1 Caption (figcaption)

Morbi id aliquet purus. Etiam vitae velit commodo, posuere nulla vel, sagittis erat. Morbi faucibus euismod mattis. Mauris at elit sit amet turpis tempor malesuada eu ut tortor. Curabitur nec nibh eget ex vehicula aliquam. Donec congue lectus quis dolor elementum porttitor. Etiam feugiat nulla nunc.

To use a Procedure Introduction (p.pi) with an Ordered List (ol):

  1. List Item (li)
  2. Sed placerat pulvinar tortor non placerat. Cras ultrices est ipsum, a molestie nibh aliquet feugiat. Nam semper, arcu nec commodo condimentum, libero nibh convallis neque, quis accumsan orci dui ac sapien. In et lorem porttitor, auctor neque eget, porttitor est. Pellentesque ac viverra lacus. Suspendisse bibendum porttitor eros, in molestie mi tristique eget. Aenean id dui congue ante semper aliquet. Pellentesque quis facilisis augue. Nulla sed consectetur quam. Nunc condimentum magna sed felis sodales, quis commodo diam dignissim. Here is a second-level Ordered List (ol):
    1. List Item (li)—lorem justo, placerat nec gravida sed, vestibulum ac diam. Donec pretium erat interdum consequat egestas. Ut gravida lacinia mauris, nec dictum ipsum bibendum quis. Vivamus ac congue ex. Integer auctor nisi ex, ac consectetur eros molestie rhoncus. Mauris eu bibendum metus, id blandit velit. Maecenas in augue eu tellus convallis luctus non quis ipsum. Phasellus dictum orci id interdum sollicitudin. Cras cursus quis sem id convallis. Nam et pharetra arcu, at vehicula felis. Here is a third-level Ordered List (ol):
      1. List Item (li)—Proin iaculis ultrices tincidunt. Nulla pulvinar tellus enim, ultrices varius felis sodales venenatis. Nam sit amet ipsum et elit eleifend vehicula. Morbi eu nibh ligula. Maecenas eleifend volutpat magna, vitae cursus metus pharetra eu. Vivamus in nisl sapien.

        Important
        Important

        Nullam dapibus nec quam et consectetur. Praesent vitae pellentesque diam, ac condimentum sem. Curabitur mattis pulvinar ligula vel rhoncus. Vivamus dictum non tellus sit amet dapibus. Pellentesque interdum augue augue, sed aliquam ante posuere vel. Donec eleifend magna nec tortor vehicula accumsan. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

      2. Proin sem velit, consectetur bibendum rutrum sed, ornare nec est. Nullam commodo tempor metus, vitae rhoncus sapien tristique a. Aliquam eleifend, ipsum nec fermentum lacinia, erat libero euismod elit, at fermentum odio nisi eu nisi.
      3. Curabitur sit amet euismod turpis. Integer non ligula vestibulum, lobortis risus ut, venenatis leo. Aenean sagittis tortor ante, et rutrum nibh viverra et. In a procedure step, you may offer the user a choice
        OR
        Integer cursus ornare condimentum. Cras gravida augue nisi. Fusce facilisis tincidunt augue vitae pretium. Nunc interdum molestie mauris a rhoncus. Aenean vitae arcu vitae nunc ultricies tempus. Phasellus nisi dolor, eleifend nec rutrum viverra, vulputate at est. Fusce urna justo, fringilla id blandit a, auctor id lorem. Nulla vehicula efficitur est sed fringilla.
      4. Suspendisse nec enim hendrerit, porta lorem gravida, auctor tellus. Ut faucibus convallis mi, in dignissim diam lobortis id. Duis scelerisque consectetur libero a condimentum.
    2. Integer placerat vel tellus at placerat. Pellentesque quis ligula lacinia, auctor nulla sed, volutpat mauris. Nunc condimentum nulla diam, sit amet euismod nisi vehicula vitae.
  3. Phasellus pellentesque ex a felis ullamcorper laoreet. Phasellus eu cursus arcu, id varius nunc. Suspendisse eget nisl quis sem iaculis viverra. Maecenas sit amet vehicula sapien. Here is an unordered list in an ordered list item:
    • Donec ornare arcu in enim faucibus tempus. Curabitur hendrerit justo justo, vel auctor nulla luctus et. Praesent rhoncus in ex cursus scelerisque. Donec non mattis ante. Maecenas bibendum nunc quis orci congue, id luctus metus feugiat. Sed porta consectetur ligula non dictum. Sed nec dolor vel odio porta tincidunt a in ex. Ut pretium sodales arcu sed congue. Vivamus eget convallis lorem.
    • Nullam rutrum metus eget arcu pharetra consequat. Pellentesque euismod, leo ac rutrum commodo, risus ante placerat ex, eu bibendum mauris urna ut sem. Donec luctus semper ligula interdum tempor. Aliquam feugiat nisi hendrerit maximus viverra. Nulla in luctus metus. Nunc quam magna, dapibus quis dolor quis, vulputate rhoncus magna. Morbi viverra ligula vitae massa lobortis, id mollis nibh hendrerit. Etiam id nibh ante.
    • Quisque fringilla faucibus libero, ac eleifend lacus lobortis quis. Morbi viverra egestas ex, ut dapibus dui scelerisque eget. Aenean scelerisque quis nunc sit amet rhoncus. Proin non sem sed nulla rutrum eleifend. Phasellus massa eros, varius vitae neque sit amet, maximus porta ante. Cras nec blandit est. Maecenas ultricies, tellus ac egestas eleifend, elit ante dictum orci, sed fringilla libero tellus ac nulla. Proin ornare vitae mauris sit amet ullamcorper. Vivamus efficitur efficitur turpis, sit amet facilisis arcu sodales nec.
  4. Nunc vitae justo egestas, congue tellus sed, iaculis orci. Praesent ultricies ut neque a elementum. Suspendisse nec sollicitudin orci. Duis bibendum placerat quam quis ornare. In hac habitasse platea dictumst. Sed mollis eros nec erat dictum vestibulum. Aenean feugiat varius ante cursus pharetra.
  5. Etiam sed tempus nunc. Nam scelerisque non orci id egestas. Sed sit amet molestie turpis, vitae ultricies metus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
  6. Nunc vehicula ipsum eget rutrum varius. Maecenas tincidunt tortor ac sem rhoncus congue. Sed imperdiet scelerisque nibh, vel dignissim augue hendrerit sed.
  7. Curabitur ac erat id quam vestibulum bibendum nec vel est. Phasellus in semper ligula, eu condimentum libero. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  8. Etiam rutrum laoreet purus, aliquet blandit libero mattis auctor. Vivamus porttitor mauris in lobortis finibus. Sed tincidunt posuere velit, vitae dapibus velit ultrices et.
  9. Morbi rhoncus erat nibh, non vehicula augue sollicitudin vitae. Vivamus at mauris ligula. Fusce commodo, nisl quis laoreet iaculis, magna turpis dignissim dolor, rutrum scelerisque est orci in quam.
  10. Etiam bibendum tortor eu nunc aliquam mattis. Vivamus malesuada, dolor vel eleifend convallis, dolor mauris posuere magna, in varius tellus sapien sit amet libero.
  11. Morbi convallis ut nisi ac mattis. In est diam, faucibus at tempus vel, ullamcorper id tellus.
  12. Sed sollicitudin, justo non ultrices finibus, velit lectus vestibulum tellus, a rutrum magna augue id enim.

Curabitur accumsan ante sed magna eleifend volutpat. Quisque porta id tellus et consectetur. Aliquam pellentesque, erat non laoreet dignissim, erat justo pulvinar velit, sit amet dapibus ante mi non risus. Praesent elementum sem eu velit iaculis interdum. Ut augue velit, consectetur id hendrerit vel, ultricies ac quam. Vivamus ut pharetra massa. Proin vulputate pulvinar tortor, fermentum imperdiet est viverra vitae. Sed vulputate eleifend feugiat.

To create a single-step procedure (ul.ss):

  • This is a single-step procedure.

Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Nulla purus tellus, maximus maximus pretium sit amet, consectetur a quam. Aenean mollis rhoncus metus, vitae iaculis urna bibendum id. Mauris placerat finibus urna vel commodo. Suspendisse tincidunt, dolor eget tristique ultrices, sem nunc placerat quam, non ultricies odio est a sapien. Nam viverra varius iaculis. Donec rutrum imperdiet arcu vitae scelerisque.

Challenge
Challenge

Use a Challenge Box (Challenge Box) to create a hands-on task or exercise based on content in the Guide for the reader to complete independently.

Curabitur suscipit ut quam nec fermentum. Integer nec velit tortor. Etiam tellus ex, ultrices tincidunt placerat gravida, efficitur vitae mauris. Cras blandit tempor magna, semper sagittis nisl porta vel. Fusce iaculis justo quis eleifend suscipit. Aliquam sagittis vulputate libero, sit amet malesuada felis faucibus vitae.

Markdown Style Guide​

In Docusaurus, the following admonitions are available when using Markdown:

note

Maecenas elementum sollicitudin nunc ac malesuada.

tip

Vivamus eu euismod dolor. Ut mi orci, ultricies at efficitur sit amet, faucibus quis leo.

info

Aliquam commodo ut ante eget sollicitudin. Donec lobortis, nisl quis dapibus lobortis, nisi nunc sodales felis, rhoncus vehicula est ipsum ac nisl.

warning

Proin non metus sit amet purus sagittis commodo. Vestibulum sit amet vestibulum justo. Suspendisse id nibh commodo, malesuada sem at, ullamcorper diam.

danger

Sed sit amet fermentum eros. Pellentesque non nunc sit amet odio cursus rutrum quis vestibulum lectus. Cras erat metus, rutrum nec accumsan non, venenatis a risus.