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.

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

a header TODO in README.org is not properly rendered #1054

Closed
dmgerman opened this issue Apr 27, 2017 · 5 comments
Closed

a header TODO in README.org is not properly rendered #1054

dmgerman opened this issue Apr 27, 2017 · 5 comments

Comments

@dmgerman
Copy link

dmgerman commented Apr 27, 2017

The file https://github.com/cregit/cregit/blob/master/authors/readme.org has a header

  • TODO

but this header is not displayed when rendered.

@nadar
Copy link

nadar commented May 8, 2017

If have seen hundreds of such render errors since weeks: https://github.com/nadar/aspsms/blob/master/README.md

I have not found any logical reason for this, nor an issues "from" github reviewing this problem.

@kivikakk
Copy link
Contributor

kivikakk commented May 9, 2017

@dmgerman

For whatever reason, the word TODO is not being rendered. I think it's because it's part of the SEQ_TODO in line 4 of the file — if you remove just TODO while leaving the others, the header starts rendering as usual. If you remove the whole line, it doesn't work, presumably because TODO is part of SEQ_TODO's default value.

@nadar

The space characters after the # in your headers need to be regular spaces (ASCII value 32) — in your README.md, they are non-breaking spaces (Unicode codepoint 160). Try changing them to regular spaces. This has happened since our change to CommonMark.

@nadar
Copy link

nadar commented May 9, 2017

Thank you @kivikakk - i just quickly created a fixer to clean up those wrong chars:

https://github.com/nadar/github-markdown-fixer

Maybe other people need something like this as well.

@dmgerman
Copy link
Author

dmgerman commented May 11, 2017 via email

@kivikakk
Copy link
Contributor

Hi @dmgerman 👋! As I mentioned, if you remove the whole line it doesn't work — I believe the "default" setting for whatever SEQ_TODO is includes TODO.

Try including this instead:

#+SEQ_TODO: STARTED DONE DEFERRED CANCELLED | WAITING DELEGATED APPT

@kivikakk kivikakk closed this as completed Jun 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants