added 6 commits
July 17, 2022 15:49Using bulleted lists can avoid unintended syntax highlighting. For "--fs-safe-rules", we will put a part of content into inline code blocks later.
There are some lines starting with two or more spaces contain the options should be links. To achieve it, the following types of lines should not be processed: - Starting with two or more spaces followed by a "%(prog)s"; - Starting with two or more spaces followed by a full-length option; - Starting with an "Example: ".
bastimeyer
changed the title
docs: use single-backtick codeblocks to protect examples and special characters; fix font styles; fix option links; add bulleted lists; add the option itself to the example; add names for special characters
docs: tweak CLI argument help texts
This will make the documentation more clear and informative both on the rendered webpages and in the manpage as well as the "--help" content. - On webpages, we will get inline code blocks; - In the manpage, we will get emphasized words (bold); - In the help content, we will get words enclosed in single backticks. This will help us remove reStructuredText markups from the docs. About "\$A": "\\$A" has been put into a code block, so the single backslash will be displayed correctly in the help content. For rendered docs, escaping backslashes is now no longer required since we did it automatically. --- A useless non-capturing group has been removed as per the suggestion: #4659 (review) Thus, Co-authored-by: bastimeyer <mail@bastimeyer.de>
bastimeyer added a commit that referenced this pull request
Jul 20, 2022This will make the documentation more clear and informative both on the rendered webpages and in the manpage as well as the "--help" content. - On webpages, we will get inline code blocks; - In the manpage, we will get emphasized words (bold); - In the help content, we will get words enclosed in single backticks. This will help us remove reStructuredText markups from the docs. About "\$A": "\\$A" has been put into a code block, so the single backslash will be displayed correctly in the help content. For rendered docs, escaping backslashes is now no longer required since we did it automatically. --- A useless non-capturing group has been removed as per the suggestion: #4659 (review) Thus, Co-authored-by: bastimeyer <mail@bastimeyer.de>
Billy2011 added a commit to Billy2011/streamlink-27 that referenced this pull request
Jul 21, 2022This will make the documentation more clear and informative both on the rendered webpages and in the manpage as well as the "--help" content. - On webpages, we will get inline code blocks; - In the manpage, we will get emphasized words (bold); - In the help content, we will get words enclosed in single backticks. This will help us remove reStructuredText markups from the docs. About "\$A": "\\$A" has been put into a code block, so the single backslash will be displayed correctly in the help content. For rendered docs, escaping backslashes is now no longer required since we did it automatically. --- A useless non-capturing group has been removed as per the suggestion: streamlink#4659 (review) Thus, Co-Authored-By: bastimeyer <mail@bastimeyer.de>
pzhlkj6612 deleted the docs-style-options-codeblocks-enhancement branch
October 30, 2022 03:25