Skip to content

Commit

Permalink
feat(docs): general improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
eeriemyxi committed Oct 22, 2024
1 parent aecbcc4 commit d127ff5
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 11 deletions.
2 changes: 1 addition & 1 deletion deno.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
"fmt": {
"indentWidth": 4
}
}
}
17 changes: 10 additions & 7 deletions docs/custom-parsers.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,15 @@ will contain your parsers.

<!-- deno-fmt-ignore -->
```yaml title=".../cela/config.yml" linenums="1"
parsers_dir: ... # /home/Documents/parsers
parsers_dir: ... # (1)
```
1. For example, `/home/myxi/Documents/parsers`

<!-- deno-fmt-ignore -->
!!! note
Please use absolute paths instead of relative ones.
!!! warning
Please use absolute paths instead of relative ones. Cela does not handle relative
paths.

Next up, create a sub-directory in the configured directory (`parsers_dir`).
Whatever you name it will be considered as the parser's id. For my example I
Expand Down Expand Up @@ -61,7 +64,7 @@ In your parser's directory you need to have a source tree like this:
<!-- deno-fmt-ignore-start-->
To complete the example I will include the example script files for `deno`.
=== "fetcher.py"
```py
```py linenums="1"
import json
import os
import sys
Expand All @@ -75,7 +78,7 @@ To complete the example I will include the example script files for `deno`.
main()
```
=== "updater.py"
```py
```py linenums="1"
import json
import os
Expand Down Expand Up @@ -152,8 +155,8 @@ fetcher's script.

## Debugging

You can see the outputs of your scripts when running with `cela` by using
`--debug` option to enable debug logs of `cela`.
You can see the outputs of your scripts when running with Cela by using
`--debug` option to enable debug logs of Cela.

## Exit Codes

Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This tool helps you increment/decrement semantic versions in files using custom
scripts and ergonomic shell commands.

# How To Use
## How to Use

<!-- deno-fmt-ignore -->
!!! tip
Expand Down Expand Up @@ -33,7 +33,7 @@ You can then provide the parser id (the folder name under
[`parsers_dir`](/custom-parsers/#custom-parsers) directory) as an argument.
E.g., `cela -MMp deno` would call the `deno` parser to update the version.

## Examples
### Examples

<!-- deno-fmt-ignore -->
!!! example
Expand Down Expand Up @@ -71,6 +71,6 @@ E.g., `cela -MMp deno` would call the `deno` parser to update the version.
[INFO] Updated version from 1.2.1 to 0.1.0 (custom).
```

# Custom Parsers
## Custom Parsers

See [Custom Parsers](/custom-parsers).
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ theme:
toggle:
icon: material/brightness-7
name: Switch to dark mode
features:
- content.code.copy
- content.code.select
- content.code.annotate
extra_css:
- css/extra.css

Expand Down

0 comments on commit d127ff5

Please sign in to comment.