docs.checklyhq.com
1.0.0
$ npm install
$ npm start
$ npm run start:api$ npm run build
$ npm run deployPush to any branch will generate deployment preview via Vercel
Push to
mainwill automatically deploy to production via Vercel
This is done automatically through a github action, see .github/worksflows/algolia-docsearch.yml.
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 ?
./site/content/docs./site/content/learn./site/content/guidesYou can make fancy fenced code blocks as follows. We recognize any typescript and javascript code blocks and add a nice logo to them.
```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.
```ts {title="src/index.ts", hl_lines=[2]}
console.log('hello world')
console.log('this will be highlighted')
console.log('goodbey world')
``` 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]> 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!Do you want to share your use case and experience using Checkly with your product? Become a guest author. Reach us at [email protected]
MIT
