-
Notifications
You must be signed in to change notification settings - Fork 20
check in help text, and add CI to verify it #411
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
9418b90
check in help text, and CI to verify it
yshavit 76ef3d8
fix help.txt
yshavit 070d30d
add permissions to help-text
yshavit 143a500
reuse binary
yshavit e9230c1
fix path
yshavit 9cc0db9
make unique more unique
yshavit File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| Select and render specific elements in a Markdown document | ||
|
|
||
| Usage: mdq [OPTIONS] [selectors] [MARKDOWN_FILE_PATHS]... | ||
|
|
||
| Arguments: | ||
| [selectors] | ||
| The selectors string | ||
|
|
||
| [MARKDOWN_FILE_PATHS]... | ||
| An optional list of Markdown files to parse, by path. If not provided, standard input will be used. | ||
|
|
||
| If these are provided, mdq will act as if they were all concatenated into a single file. For example, if you use --link-pos=doc, the link definitions for all input files will be at the very end of the output. | ||
|
|
||
| A path of "-" represents standard input. | ||
|
|
||
| If these are provided, standard input will not be used unless one of the arguments is "-". Files will be processed in the order you provide them. If you provide the same file twice, mdq will process it twice, unless that file is "-"; all but the first "-" paths are ignored. | ||
|
|
||
| This line is intentionally added as a test. A line within the --link-pos text has been intentionally removed. | ||
|
|
||
| Options: | ||
| --link-pos <LINK_POS> | ||
| Where to put link references. | ||
|
|
||
| For links and images of style `[description][1]`, this flag controls where to put the `[1]: https://example.com` definition. | ||
|
|
||
| - section: Show link definitions in the first section that uses the link | ||
| - doc: Show link definitions at the bottom of the document | ||
|
|
||
| [default: section] | ||
|
|
||
| --footnote-pos <FOOTNOTE_POS> | ||
| Where to put footnote references. Defaults to be same as --link-pos | ||
|
|
||
| Possible values: | ||
| - section: Show link definitions in the first section that uses the link | ||
| - doc: Show link definitions at the bottom of the document | ||
|
|
||
| -l, --link-format <LINK_FORMAT> | ||
| Possible values: | ||
| - keep: Keep links as they were in the original | ||
| - inline: Turn all links into inlined form: `[link text](https://example.com)` | ||
| - never-inline: Never output `[inline](https://example.com)` links[default: never-inline] | ||
|
|
||
| --renumber-footnotes <RENUMBER_FOOTNOTES> | ||
| [default: true] | ||
| [possible values: true, false] | ||
|
|
||
| -o, --output <OUTPUT> | ||
| Specifies the output format. Defaults to markdown | ||
|
|
||
| Possible values: | ||
| - markdown: Output results as Markdown | ||
| - md: Alias for markdown | ||
| - json: Output results as JSON. Spans of inline elements (like within a single paragraph) will be rendered as a single string of Markdown, not as separate JSON elements | ||
| - plain: Outputs just the plain text. This retrains the spacing between paragraphs and paragraph-like blocks (code blocks, block quotes, etc.) but removes all other formating, including inline formatting. Links are rendered as just their display text, and footnotes are removed entirely | ||
|
|
||
| [default: markdown] | ||
|
|
||
| --wrap-width <WRAP_WIDTH> | ||
| The number of characters to wrap text at. This is only valid when the output format is markdown. | ||
|
|
||
| Certain elements (like section headings and link definitions) will never be wrapped, and the wrapping will never break a word; it will only ever be along existing whitespace. In particular, this means the wrapping will never add hyphens, and it will never break URLs. | ||
|
|
||
| -q, --quiet | ||
| Quiet: do not print anything to stdout. The exit code will still be 0 if any elements match, and non-0 if none do | ||
|
|
||
| --[no]-br | ||
| Include breaks between elements in plain and markdown output mode. | ||
|
|
||
| For plain, this will add a blank line between elements. For markdown, this will add a thematic break ("-----") between elements. | ||
|
|
||
| This has no effect in JSON output mode. | ||
|
|
||
| This defaults to true for Markdown output, and false for plain text output. | ||
|
|
||
| -h, --help | ||
| Print help (see a summary with '-h') | ||
|
|
||
| -V, --version | ||
| Print version |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.