-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: moves learn styling to docs. Replaces unneeded shortcodes with …
…markdown hooks
- Loading branch information
Showing
105 changed files
with
485 additions
and
682 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,15 +26,60 @@ This is done automatically through a github action, see `.github/worksflows/algo | |
|
||
## Docs, Learn & Guides | ||
|
||
Docs, Learn & Guides sections are open to contributions. If you find a mistake or you think that something could be improve, please open a PR 🙂 | ||
Docs, Learn & Guides sections are open to contributions. If you find a mistake, or you think that something could be improved, please open a PR 🙂 | ||
|
||
- Docs: `./site/content/docs` | ||
- Learn: `./site/content/learn` | ||
- Guides: `./site/content/guides` | ||
|
||
## Markdown extensions | ||
|
||
### Fancy fenced code blocks with title | ||
|
||
You can make fancy fenced code blocks as follows. We recognize any typescript and javascript code blocks and | ||
add a nice logo to them. | ||
|
||
````markdown | ||
```ts {title="src/index.ts"} | ||
console.log('hello world') | ||
``` | ||
```` | ||
|
||
You can also highlight certain lines in the code block by adding a `hl_lines` attribute to the code block. | ||
|
||
````markdown | ||
```ts {title="src/index.ts", hl_lines=[2]} | ||
console.log('hello world') | ||
console.log('this will be highlighted') | ||
console.log('goodbey world') | ||
``` | ||
```` | ||
|
||
### Alerts | ||
|
||
We removed all the custom Hugo shortcodes and replaced them with markdown alerts. You can use the following types: | ||
|
||
- `[!NOTE]` (default, same as not specifying any type) | ||
- `[!WARNING]` | ||
- `[!CLI]` | ||
````markdown | ||
> This is a default note / info alert. | ||
|
||
> [!NOTE] | ||
> This is the same as the default note / info alert, just more explicit. | ||
|
||
> [!WARNING] | ||
> This is a warning. | ||
|
||
> [!CLI] | ||
> This adds a CLI tip! | ||
```` | ||
|
||
|
||
## Blog | ||
|
||
Do you want to share your use case and experience using Checkly with your product? Become a guest author. Reach us at [[email protected]](mailto:[email protected]) | ||
Do you want to share your use case and experience using Checkly with your product? Become a guest author. | ||
Reach us at [[email protected]](mailto:[email protected]) | ||
|
||
## License | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,6 +30,4 @@ From now on when logging in you will be asked to provide a one time password. | |
- To stop using MFA, toggle the 'Enable multi-factor authentication' setting under User Settings. | ||
- If you have lost access to your authenticator app or removed the Checkly configuration from it, contact [[email protected]](mailto:[email protected]) for help with resetting your configration. | ||
|
||
{{< info >}} | ||
Multi-factor authentication is available on the Team and Enterprise plans. | ||
{{< /info >}} | ||
> Multi-factor authentication is available on the Team and Enterprise plans. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.