Skip to content

Commit

Permalink
task: adding a flags to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
paganotoni committed Jan 19, 2024
1 parent 5ddf220 commit d4712e3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/The CLI/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,16 @@ index: 2

Build generates the static documentation site from the markdown files in the `docs` folder. It will create a `public` folder with the static website.


```sh
$ doco build
# or a different folder name
$ doco --folder [folder] build
# or a different output folder
$ doco --output [output] build
```

When the docs folder does not exist, it stops the operation and error out with:

```sh
ERROR: docs folder does not exist, aborting build
```
2 changes: 2 additions & 0 deletions docs/The CLI/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ index: 1
Init creates the `docs` folder with some basic files.

```sh
$ doco init
# or a different folder name
$ doco --folder [folder] init
```

Expand Down

0 comments on commit d4712e3

Please sign in to comment.