Pular para o conteúdo principal

Documentation Style Guide

You can write content using GitHub-flavored Markdown syntax.

You can also consult Docusaurus examples.

Markdown Syntax

To serve as an example page when styling markdown based Docusaurus sites.


H1 - Create the best documentation

H2 - Create the best documentation

H3 - Create the best documentation


Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

Strikethrough uses two tildes. Scratch this.


  1. First ordered list item
  2. Another item
    • Unordered sub-list.
  3. Actual numbers don't matter, just that it's a number
    1. Ordered sub-list
  4. And another item.
  • Unordered list can use asterisks
  • Or minuses
  • Or pluses

I'm an inline-style link

I'm an inline-style link with title

I'm a reference-style link

You can use numbers for reference-style link definitions

Or leave it empty and use the link text itself.

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com/ or http://www.example.com/ and sometimes example.com (but not on GitHub, for example).

Some text to show that the reference links can follow later.


Here's our logo (hover to see the title text):

Images from any folder can be used by providing path to file. Path should be relative to markdown file.



Documentation Repositorie


You can add a title here
var s = 'JavaScript syntax highlighting';
s = "Python syntax highlighting"
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
function highlightMe() {
console.log('This line can be highlighted!');
function HighlightSomeText(highlight) {
if (highlight) {
return 'This text is highlighted!';

return 'Nothing highlighted';

function HighlightMoreText(highlight) {
if (highlight) {
return 'This range is highlighted!';

return 'Nothing highlighted';


Colons can be used to align columns.

col 3 isright-aligned\$1600
col 2 iscentered\$12
zebra stripesare neat\$1

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.


Custom Table

nameStringName to reference the valued passed
valueAnyAny type of value can be passed


Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.

Quote break.

This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.

Inline HTML

Definition list
Is something people use sometimes.
Markdown in HTML
Does *not* work **very** well. Use HTML tags.

Line Breaks

Here's a line for us to start with.

This line is only separated by a single newline, so it's a separate line in the same paragraph.



This is a note


This is a tip


This is important


This is a caution


This is a warning