Skip to content

Simplify documentation structure and content #557

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Simplify documentation structure and content #557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 27 additions & 23 deletions code.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,42 @@ description: "Display inline code and code blocks"
icon: 'code'
---

## Basic
## Inline Code

### Inline Code
To add inline code, wrap text in single backticks: `like this`

To denote a `word` or `phrase` as code, enclose it in backticks (\`).
## Code Blocks

```
To denote a `word` or `phrase` as code, enclose it in backticks (`).
```
### Basic Code Block

Create a code block by wrapping your code in three backticks (```). Add a language name after the opening backticks for syntax highlighting.

```python
def hello_world():
print("Hello, World!")
```

```md
\```python
def hello_world():
print("Hello, World!")
\```
```

### Code Block
### Named Code Blocks

Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language.
You can add a name to your code block by adding text after the language:

```java HelloWorld.java
class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```javascript hello.js
console.log("Hello, World!");
```

````md
```java HelloWorld.java
class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```md
\```javascript hello.js
console.log("Hello, World!");
\```
```
````

Visit the [Code Block page](/content/components/code) for more detailed docs.
<Note>
We use [Prism](https://prismjs.com/#supported-languages) for syntax highlighting. See their documentation for a full list of supported languages.
</Note>
39 changes: 16 additions & 23 deletions content/components/accordions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,34 @@ description: "A dropdown component to toggle content"
icon: "square-caret-down"
---

<Accordion title="I am an Accordion.">
You can put any content in here. Check out
[AccordionGroup](/content/components/accordion-groups) if you want to group
multiple Accordions into a single display.
Accordions let you hide and show content in an expandable section. They're great for FAQs or organizing long content into collapsible sections.

<Accordion title="Basic Accordion Example">
This is an example of basic accordion content. You can put text, lists, code, or any other content inside.
</Accordion>

<RequestExample>
## Usage

```jsx Accordion Example
<Accordion title="I am an Accordion.">
You can put any content in here.
```jsx
<Accordion title="My Section">
Your content goes here
</Accordion>
```

</RequestExample>

## Props

<ResponseField name="title" type="string" required>
Title in the Accordion preview.
The text shown in the accordion header
</ResponseField>

<ResponseField name="description" type="string">
Detail below the title in the Accordion preview.
<ResponseField name="defaultOpen" type="boolean" default={false}>
Set to `true` to have the accordion open by default
</ResponseField>

<ResponseField name="defaultOpen" type="boolean" default="false">
Whether the Accordion is open by default.
<ResponseField name="icon" type="string">
Optional [Font Awesome icon](https://fontawesome.com/icons) to show next to the title
</ResponseField>

<ResponseField name="icon" type="string or svg">
A [Font Awesome icon](https://fontawesome.com/icons) or SVG code
</ResponseField>

<ResponseField name="iconType" type="string">
One of "regular", "solid", "light", "thin", "sharp-solid", "duotone", or
"brands"
</ResponseField>
<Tip>
Need to group multiple accordions? Check out [AccordionGroup](/content/components/accordion-groups).
</Tip>
27 changes: 20 additions & 7 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,12 @@
{
"group": "Editing",
"icon": "pen-paintbrush",
"pages": ["development", "web-editor"]
"pages": [
"development",
"web-editor",
"list-table",
"text"
]
},
"settings/global",
{
Expand All @@ -37,7 +42,9 @@
]
},
"themes",
"migration"
"migration",
"code",
"quickstart"
]
},
{
Expand Down Expand Up @@ -133,7 +140,10 @@
{
"group": "Dashboard Access",
"icon": "house-lock",
"pages": ["advanced/dashboard/sso", "advanced/dashboard/permissions"]
"pages": [
"advanced/dashboard/sso",
"advanced/dashboard/permissions"
]
},
{
"group": "REST API",
Expand Down Expand Up @@ -181,7 +191,8 @@
"content/components/steps",
"content/components/tabs",
"content/components/tooltips",
"content/components/update"
"content/components/update",
"content/components/accordions"
]
},
{
Expand All @@ -205,7 +216,7 @@
"pages": [
"integrations/analytics/overview",
"integrations/analytics/amplitude",
"integrations/analytics/clearbit",
"integrations/analytics/clearbit",
"integrations/analytics/fathom",
"integrations/analytics/google-analytics",
"integrations/analytics/google-tag-manager",
Expand Down Expand Up @@ -251,7 +262,9 @@
"groups": [
{
"group": "Changelog",
"pages": ["changelog/overview"]
"pages": [
"changelog/overview"
]
}
]
}
Expand Down Expand Up @@ -363,4 +376,4 @@
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
}
}
}
}
93 changes: 31 additions & 62 deletions list-table.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,86 +3,55 @@ title: "Lists and Tables"
description: "Display information in lists and tables"
icon: 'list'
---
## Lists
### Ordered List

To create an ordered list, add line items with numbers followed by periods

1. First item
2. Second item
3. Third item
4. Fourth item

```md
1. First item
2. Second item
3. Third item
4. Fourth item
```
## Lists

### Unordered List
### Simple Lists

To create an unordered list, add dashes (`-`), asterisks (`*`), or plus signs (`+`) in front of line items
Create a list by adding dashes (`-`) in front of items:

- First item
- Second item
- Third item
- Fourth item
- Apple
- Banana
- Orange

```md
- First item
- Second item
- Third item
- Fourth item
- Apple
- Banana
- Orange
```

### Nested List

Add indents on list items to nest them
For numbered lists, use numbers with periods:

- First item
- Second item
- Additional item
- Additional item
- Third item
1. First step
2. Second step
3. Third step

```md
- First item
- Second item
- Additional item
- Additional item
- Third item
1. First step
2. Second step
3. Third step
```

<Tip>

Lists follow the official [markdown syntax](https://www.markdownguide.org/basic-syntax/#lists-1).

Need more list options? Check out the [markdown syntax guide](https://www.markdownguide.org/basic-syntax/#lists-1).
</Tip>

## Tables

| Property | Description |
| -------- | ------------------------------------- |
| Name | Full name of user |
| Age | Reported age |
| Joined | Whether the user joined the community |
Create simple tables using pipes (`|`) and hyphens (`-`):


### Creating a table

<Tip>

The Table component follows the official [markdown syntax](https://www.markdownguide.org/extended-syntax/#tables).

</Tip>

To add a table, use three or more hyphens (`---`) to create each column's header, and use pipes (`|`) to separate each column. For compatibility, you should also add a pipe on either end of the row.
| Name | Type | Description |
|-------|---------|-------------------|
| id | string | Unique identifier |
| title | string | Item title |
| date | string | Creation date |

```md
| Property | Description |
| -------- | ------------------------------------- |
| Name | Full name of user |
| Age | Reported age |
| Joined | Whether the user joined the community |
```
| Name | Type | Description |
|-------|---------|-------------------|
| id | string | Unique identifier |
| title | string | Item title |
| date | string | Creation date |
```

That's it! Tables are great for displaying structured data in a clear format.
Loading
Loading