File tree Expand file tree Collapse file tree 1 file changed +3
-3
lines changed Expand file tree Collapse file tree 1 file changed +3
-3
lines changed Original file line number Diff line number Diff line change 9
9
10
10
** tl;dr** : Once you've configured quartodoc in your ` _quarto.yml ` file, use the following commands to build and preview a documentation site.
11
11
12
- ## Create documentation files with ` quartodoc build `
12
+ ## ` quartodoc build ` : Create doc files
13
13
14
14
Automatically generate ` .qmd ` files with reference api documentation. This is written by default to the reference/ folder in your quarto project.
15
15
@@ -35,15 +35,15 @@ quartodoc build --help
35
35
```
36
36
37
37
38
- ## Create inventory files with ` quartodoc interlinks `
38
+ ## ` quartodoc interlinks ` : Create inventory files
39
39
40
40
Inventory files facilitate linking to API doc pages within and across ` quartodoc ` sites. This is optional.
41
41
42
42
``` bash
43
43
quartodoc interlinks
44
44
```
45
45
46
- ## Preview the site with ` quarto preview `
46
+ ## ` quarto preview ` : Preview the site
47
47
48
48
Use ` quarto ` to preview the site:
49
49
You can’t perform that action at this time.
0 commit comments