Skip to content

Commit 3d5a755

Browse files
make pkgdown pass
1 parent 5b267a3 commit 3d5a755

File tree

6 files changed

+19
-0
lines changed

6 files changed

+19
-0
lines changed

_pkgdown.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,21 @@ reference:
2525
destination: docs
2626
articles:
2727
- title: Get started
28+
description: >
29+
All you need to know as a {precommit} (power) user.
2830
navbar: ~
2931
contents:
32+
- precommit
3033
- why-use-hooks
3134
- available-hooks
3235
- ci
3336
- FAQ
37+
- title: Developer Docs
38+
description: >
39+
You won't need this unless you want to contribute to that repo.
40+
contents:
41+
- hook-order
42+
- testing
3443

3544
template:
3645
params:

vignettes/FAQ.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: "FAQ"
33
output: rmarkdown::html_vignette
4+
description: >
5+
Common questions and answers for pre-commit users.
46
vignette: >
57
%\VignetteIndexEntry{FAQ}
68
%\VignetteEncoding{UTF-8}

vignettes/available-hooks.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: "Available Hooks"
3+
description: >
4+
Check out all hooks this repo contains and how they can be customized
35
output: rmarkdown::html_vignette
46
vignette: >
57
%\VignetteIndexEntry{available-hooks}

vignettes/ci.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: "Continuous Integration"
3+
description: >
4+
Understand how pre-commit can be used in a continuous integration settting.
35
output: rmarkdown::html_vignette
46
vignette: >
57
%\VignetteIndexEntry{Continuous Integration}

vignettes/precommit.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: "precommit"
3+
description: >
4+
Learn how to get started with the basics of {precommit}.
35
output: rmarkdown::html_vignette
46
vignette: >
57
%\VignetteIndexEntry{precommit}

vignettes/why-use-hooks.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: "Why is this useful?"
33
output: rmarkdown::html_vignette
4+
description: >
5+
Understand why we build this and why we think it's useful.
46
vignette: >
57
%\VignetteIndexEntry{why-use-hooks}
68
%\VignetteEncoding{UTF-8}

0 commit comments

Comments
 (0)