-
Notifications
You must be signed in to change notification settings - Fork 342
docs: remove unicode zero length characters and fix Markdown to man page conversion #326
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
Conversation
ConradIrwin
commented
Sep 15, 2020
@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?
lucasrangit
commented
Sep 16, 2020
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: ```
364c70a to
545d204
Compare
lucasrangit
commented
Sep 16, 2020
@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?
You were absolutely right. The man page came out fine without the asterisks. But to be consistent, I replaced the Unicode with asterisks since there were getting substituted in the Rakefile anyway and the Markdown looks the same on GitHub. I think the Unicode make it harder to edit.
I also noticed a few other Markdown to man page issues and fixed them.
bl-ue
commented
Apr 2, 2021
cc @ConradIrwin
lucasrangit
commented
Apr 4, 2021
Thanks for the review @bl-ue . Just curious, does this PR address any issues with tldr?
Sharp eye you have there, @lucasrangit! 😎
As it happens, this PR doesn't fix anything with tldr. I started browsing this repo because I was reviewing a pull request of @nicokosi's (tldr-pages/tldr#5666), and then I came upon this PR. Seeing some uncertainty as to the benefit of this PR (which, by the way, is great and definitely needed), I thought I'd add my +1.
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!!
@utkarsh2102
utkarsh2102
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Me likey! 👍🏻
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.