docs: remove unicode zero length characters and fix Markdown to man page conversion#326
docs: remove unicode zero length characters and fix Markdown to man page conversion#326lucasrangit wants to merge 5 commits into
Conversation
|
@lucasrangit I think these zero-width characters are used in the production of the man page, though it's been a long time since I looked into it, does that still work correctly without them? |
|
Oh! 😮 I'll check. |
Fix the following by not using `####` (h4) in Markdown ``` $ ronn --roff --manual="Gist manual" README.md warn: unrecognized block tag: "h4" ```
… compatible with man page generated with ronn and make it easier to edit the README.md Removing the unicode makes editing it easier. However, ronn has some issues with Markdown to man page format. For example, adding colons to the end of a bulleted line may disable bullets for the whole section.
The triple backtick code block was confusing `ronn` causing the token section to flow into the library section.
```
Token file format
If you cannot use passwords, as most Enterprise installations do, you can generate the token via the web interface and then simply save the string in the correct file. Avoid line breaks or you might see: $ gist -l Error: Bad
credentials
You can also use Gist as a library from inside your ruby code:
```
lucasrangit
force-pushed
the
docs-typo
branch
from
364c70a to
545d204
Compare
You were absolutely right. The I also noticed a few other Markdown to |
lucasrangit
changed the title
|
cc @ConradIrwin |
|
Thanks for the review @bl-ue . Just curious, does this PR address any issues with |
|
Sharp eye you have there, @lucasrangit! 😎 As it happens, this PR doesn't fix anything with In fact, you can even see "<200c>For Ubuntu/Debian" right on the readme 😝 However, you're more than most welcome to contribute in any way to the tldr-pages project, if you feel inclined to do so!! |
7 participants
Fix the typo from #325 and remove Unicode zero width characters from Markdown. Also format some vars with backticks.
Rendering of the README.md on github.com has not changed without the Unicode characters.