Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 1.71 KB

github_styling_reference.md

File metadata and controls

62 lines (39 loc) · 1.71 KB

import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/' import { Install, InstallBox } from '@site/src/components/Install/' import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Title

(We should keep it the same as the one mentioned in the "title" metadata, so it renders the same on both Docusaurus and GitHub)

Text regarding the document

(we will use the below notes instead of github admonitions. To use the emojis, type a : and then start typing the emoji name. The ones we are going to use are: info and note -> "bookmark_tabs", best practice and tip-> "bulb", warning and caution -> "warning" )

📑 Info, Note

This is an info or a note block.

💡 Tip, Best Practice

This is a tip or a best practice block.

⚠️ Warning, Caution

This is a warning or a caution block.

Header_Text

Description of the header

(when we use docusaurus tabs, we should have also the tab's name as a sentence in a heading below, as such:)

Header for tab1

text for tab1, both visible in GitHub and Docusaurus

Header for tab2

text for tab2, both visible in GitHub and Docusaurus

(If the heading is not an h4 (h4 isn't rendered in the right navigation bar, hence it doesn't produce any problems), use HTML headings instead.) (due to the nature of the way github reads HTML elements, we can't use the HTML codeblock element for tab labels, we will only use text, and it will be hidden from the preview)

Sample_Heading

The text continues below...