docs.checklyhq.com
1.0.0
$ npm install
$ npm start
$ npm run start:api$ npm run build
$ npm run deployТолк до любого филиала будет генерировать предварительный просмотр развертывания через Vercel
Push to
mainбудет автоматически развернуться до производства через Vercel
Это делается автоматически через действие GitHub, см .github/worksflows/algolia-docsearch.yml .
Документы, обучение и руководства разделы открыты для вклада. Если вы найдете ошибку или думаете, что что -то может быть улучшено, пожалуйста, откройте PR?
./site/content/docs./site/content/learn./site/content/guides Вы можете сделать причудливые огороженные кодовые блоки следующим образом. Мы распознаем любые блоки кода TypeScript и JavaScript и добавляем в них хороший логотип.
``` ts {title="src/index.ts"}
console . log ( ' hello world ' )
``` Вы также можете выделить определенные строки в блоке кода, добавив атрибут hl_lines в кодовый блок.
``` ts {title="src/index.ts", hl_lines=[2]}
console . log ( ' hello world ' )
console . log ( ' this will be highlighted ' )
console . log ( ' goodbey world ' )
``` Мы удалили все индивидуальные шорткоды Hugo и заменили их на оповещения Marckdown. Вы можете использовать следующие типы:
[!NOTE] (по умолчанию, так же, как не указано ни одного типа)[!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! Вы хотите поделиться вашим вариантом использования и опытом, используя проверку с вашим продуктом? Станьте приглашенным автором. Связаться с нами по адресу [email protected]
Грань
