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

✏️ Fix Typos #65

Merged
merged 5 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
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
38 changes: 35 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,38 @@
Repository for [Trio documentation (under development)](https://docs.diy-trio.org)

Tips & Tricks: (please add!)
## Tips & Tricks

* Using the # sign shows a chapter on the menu/index. The amount of #'s determin the level. If you don't want a chapter to end up in the menu/index, use bold text by adding ** or using < b > before the text and < / b > after the text (without spaces).
* When linking to other md files that are in another directory, the link must start with ../ - example: ../directoryname/filename.md
> [!NOTE]
> Please add!

### Add a Chapter

Using the `#` sign shows a chapter on the menu/index. The amount of `#`'s determines the level.

**Example**:

```markdown
# README

## Tips & Tricks

### Add a Chapter

### Link to Another File
```

> [!TIP]
> If you want to avoid a chapter ending up in the menu/index, use bold text by:
> - either surrounding the text with 2-star signs `**`
> - or adding `<b>` before the text and `</b>` after the text (without spaces).
>
> Input | Result
> ------------------ | -------------
> `**bold text**` | **bold text**
> `<b>bold text</b>` | **bold text**

### Link to Another File

When linking to another Markdown file (ending with `.md`) in another directory, the link must start with `../`.

**Example**: `../directoryname/filename.md`
Loading