Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add table of contents and tabs group to style guide #678

Merged
merged 2 commits into from
Apr 30, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 52 additions & 20 deletions pages/md-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,140 +6,172 @@ Contributors to our Docs and Blog can use any of these custom markdown tags to e

<!-- ### 🚀 Custom Markdown Writing Style Guide -->

### **Star**
## Star

Adds a star with label along with it. In place of `"label"` text can be added which needs to be shown.

```markdown
<Star label="label"/>
```

#### Example
### Example

<Star label="label"/>

---

### **StarInline**
## StarInline

Adds an inline star with the label along with it. In place of `"label"` text can be added which needs to be shown.

```markdown
<StarInline label="label"/>
```

#### Example
### Example

<StarInline label="label"/>

---

### **Summary**
## Summary

Summary and details tags both can be used together the text wrapped in the `summary` tag will be shown primarily, whereas the text shown in the `details` tag can be shown when its cliced on the summary text.

```markdown
<summary> message to show </summary>
```

#### Example
### Example

<summary> message to show </summary>

---

### **Details**
## Details

Summary and details tags both can be used together the text wrapped in the `summary` tag will be shown primarily, whereas the text shown in the `details` tag can be shown when its cliced on the summary text.

```markdown
<details> message to show </details>
```

#### Example
### Example

<details> message to show </details>

---

### **Bigquote**
## Bigquote

Useful to show the text wrapped in it, in a big quotation-like text.

```markdown
<Bigquote> message to show </Bigquote>
```

#### Example
### Example

<Bigquote> message to show </Bigquote>

---

### **Blockquote**
## Blockquote

Useful to show the text wrapped in it, in a block quotation-like text.

```markdown
<blockquote> message to show </blockquote>
```

#### Example
### Example

<blockquote> message to show </blockquote>

---

### **Infobox**
## Infobox

Infobox is useful for presenting an information, inside a box. The text written between these tags will be shown.

```markdown
<Infobox label="label"> message to show. </Infobox>
```

#### Example
### Example

<Infobox label="label"> message to show. </Infobox>

---

### **Warning**
## Warning

Warning is a special type of info box in which text showing any warning can be shown. The text written between these tags will be shown.

```markdown
<Warning label="label"> message to show. </Warning>
```

#### Example
### Example

<Warning label="label"> message to show. </Warning>

---

### **Tip**
## Tip

Tip is a special type of info box in which text showing a tip can be shown. The text written between these tags will be shown.

```markdown
<Tip label="label"> message to show. </Tip>
```

#### Example
### Example

<Tip label="label"> message to show. </Tip>

---

### **Danger**
## Danger

Danger is a special type of info box in which text showing any danger can be shown. The text written between these tags will be shown.

```markdown
<Danger label="label"> message to show. </Danger>
```

#### Example
### Example

<Danger label="label"> message to show. </Danger>

---

## Table of Contents

Table of Contents provides a structured overview of the main sections or chapters within the current page/document.

```markdown
<TableOfContent content={content} depth={depth} />
```

---

## Tabs Group

This can be used to group multiple tabs under a common name and differentiated by specific labels and content.

```markdown
[ tabs-start "label" ]
[ tab "name" ]
message to show
[ tabs-end ]
```

### Example

[tabs-start "label"]
[tab "name"]
message to show
[tab "name"]
message to show
[tabs-end]
Loading