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

Todo list outlines in GitHub? Still can't find the way... #100

scripting opened this Issue Oct 28, 2018 · 3 comments


None yet
3 participants

scripting commented Oct 28, 2018

Here's an example of a worknotes outline of mine in a GitHub repo.

This is one of several ways I've tried doing it. None of them work well.

In this example, the problem is:

  1. No permalinks.

  2. No wordwrap for paragraphs.

  3. Simple HTML not rendered as HTML (look at the <a href>'s.)

Every other way I've tried, using markdown or not, has mangled it in other ways such that it's unreadable.

This is a problem for me because it's how I write docs and take notes while developing. Outlines and technical docs are basically the same thing. Imagine how great it would be if GH were good at displaying outlines.

I'd welcome any suggestions for how to make this work. I'm out of ideas.


This comment has been minimized.

ttepasse commented Oct 28, 2018

I transformed your notes into Markdown's nested lists. Because my file has the .md ending, Github displays it rendered; the Raw button displays the simple source. Markdown gives you wordwrap and HTML support. Permalinks, I'm afraid, are only supported for headings. Don't know if that helps with your workflow, but that would be my first thought.


This comment has been minimized.


scripting commented Oct 28, 2018


This comment has been minimized.

je-r commented Oct 29, 2018

maybe GitHub actions will help you to convert outline to HTML to your liking upon commit? - I’ve signed up for beta but not approved yet

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