Skip to content

Commit 67a76e3

Browse files
committed
doc: added docs for --version
- replaced the outdated showcase image in the readme with the newly added list parsing - update help message information in Usage.md - check the list item for lists in Features.md
1 parent fedef79 commit 67a76e3

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,5 @@ Until a release is ready please build from source.
3434
fleck README.md
3535
```
3636

37-
- View the output: ![Readme.png](./doc/assets/README.png)
37+
- View the output:
38+
![Readme.png](./doc/assets/README.png)

doc/Features.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Fleck implements the basic markdown features everyone needs, while extending mar
66

77
- [x] Headers
88
- [x] Blockquotes
9-
- [ ] unordered Lists
9+
- [x] unordered Lists
1010
- [ ] to-do lists
1111
- [x] Code blocks
1212
- [x] Code inline

doc/Usage.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Usage:
2121
2222
Options:
2323
--debug enables debug logs
24+
--version prints version and build information, exists
2425
--no-prefix hide the informational comments generated in the output html
2526
--no-template write html output to a file without the default html scaffolding
2627
--silent disables info logs, reduces output significantly
@@ -30,7 +31,7 @@ Options:
3031
--preprocessor-enabled enables the preprocessor to replace macros, decreases performance
3132
--shell-macro-enabled enables the dangerous '@shell{command}' macro, which allows the preprocessor to run any command on your system
3233
33-
2023/04/14 10:02:52 error: not enough arguments, specify an input file
34+
2023/04/17 08:53:58 error: not enough arguments, specify an input file
3435
exit status 1
3536
```
3637

@@ -41,6 +42,7 @@ exit status 1
4142
| Option | description | default value |
4243
| ------------------------ | ----------------------------------------------------------------- | ------------- |
4344
| `--debug` | enables debug logs | false |
45+
| `--version` | prints version and build information, exists | false |
4446
| `--no-prefix` | hide the informational comments generated in the output html | false |
4547
| `--no-template` | write html output to a file without the default html scaffolding | false |
4648
| `--silent` | disables all info logs, keeps warnings and errors | false |

doc/assets/README.png

-5.17 KB
Loading

0 commit comments

Comments
 (0)