Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: remove unicode zero length characters and fix Markdown to man page conversion #326

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

docs: remove unicode zero length characters and fix Markdown to man page conversion #326

wants to merge 5 commits into from

Conversation

lucasrangit
Copy link
Contributor

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.

@ConradIrwin
Copy link
Collaborator

@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
Copy link
Contributor Author

Oh! 😮 I'll check.

@lucasrangit
docs: README: one more unicode char
6ec0a68
@lucasrangit
docs: man: ronn doesn't like h4
545d204 
Fix the following by not using `####` (h4) in Markdown

```
$ ronn --roff --manual="Gist manual" README.md
warn: unrecognized block tag: "h4"
```
@lucasrangit
docs: replace the unicode zero length characters with asterisks to be…
b9cebf9 
… 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.
@lucasrangit
docs: man: workaround ronn Markdown bug
4c5aa45 
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
Copy link
Contributor Author

@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.

@lucasrangit lucasrangit changed the title docs: remove unicode zero length character docs: remove unicode zero length characters and fix Markdown to man page conversion Sep 16, 2020
@bl-ue
Copy link

bl-ue commented Apr 2, 2021

cc @ConradIrwin

@lucasrangit
Copy link
Contributor Author

Thanks for the review @bl-ue . Just curious, does this PR address any issues with tldr?

@bl-ue
Copy link

bl-ue commented Apr 4, 2021 •
edited
Loading

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 approved these changes May 17, 2021
View reviewed changes
Copy link

@utkarsh2102 utkarsh2102 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Me likey! 👍🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@38484737 38484737 38484737 approved these changes

@misha1528 misha1528 misha1528 approved these changes

@bl-ue bl-ue bl-ue approved these changes

@utkarsh2102 utkarsh2102 utkarsh2102 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@lucasrangit @ConradIrwin @bl-ue @utkarsh2102 @misha1528 @38484737 @Lissywills1732