Skip to content

Commit

Permalink
update help message
Browse files Browse the repository at this point in the history
  • Loading branch information
kpym committed Jan 26, 2024
1 parent eb2204d commit d5f35fb
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion HOWTO.md
Expand Up @@ -64,7 +64,7 @@ Here is an example of possible `.gitlab-ci.yml`:
pages:
image: alpine
script:
- wget -c https://github.com/kpym/gm/releases/download/v0.17.0/gm_0.17.0_Linux_64bit.tar.gz -O - | tar -C /usr/local/bin -xz gm
- wget -c https://github.com/kpym/gm/releases/download/v0.17.1/gm_0.17.1_Linux_64bit.tar.gz -O - | tar -C /usr/local/bin -xz gm
- gm --pages '**/*'
artifacts:
paths:
Expand Down
5 changes: 3 additions & 2 deletions README.md
Expand Up @@ -23,13 +23,14 @@ This tool is a thin wrapper around the [github.com/yuin/goldmark](https://github

```
> gm -h
gm (version: 0.17.0): a goldmark cli tool which is a thin wrapper around github.com/yuin/goldmark (versio: v1.5.6).
gm (version: 0.17.1): a goldmark cli tool which is a thin wrapper around github.com/yuin/goldmark (versio: v1.5.6).
If not serving (no '--serve' or '-s' option is used):
- the .md files are converted and saved as .html with the same base name;
- if the .html file exists it is overwritten;
- if the corresponding .html file already exists, it is overwritten;
- 'stdin' is converted to 'stdout';
- when a pattern is used, only the matched .md files are considered.
- the pattern can contain '*', '?', the '**' glob pattern, '[class]' and {alt1,...} alternatives.
When serving (with '--serve' or '-s' option):
- the .md files are converted and served as html with live.js (for live updates);
Expand Down
3 changes: 2 additions & 1 deletion gm_parameters.go
Expand Up @@ -30,9 +30,10 @@ func help() {
If not serving (no '--serve' or '-s' option is used):
- the .md files are converted and saved as .html with the same base name;
- if the .html file exists it is overwritten;
- if the corresponding .html file already exists, it is overwritten;
- 'stdin' is converted to 'stdout';
- when a pattern is used, only the matched .md files are considered.
- the pattern can contain '*', '?', the '**' glob pattern, '[class]' and {alt1,...} alternatives.
When serving (with '--serve' or '-s' option):
- the .md files are converted and served as html with live.js (for live updates);
Expand Down

0 comments on commit d5f35fb

Please sign in to comment.