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

Open
#100 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
github, html, markdown

Research direction

Start by reviewing the linked example in misc/outline.txt and the three listed problems: missing permalinks, absent paragraph wrapping, and unrendered simple HTML. Before implementation, establish which outline and document formats GitHub should support and define the rendering behavior that would make the example readable.

Written by the indexing model from the issue text.

Description

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.

Dominant language
HTML
Stars
134
Forks
10
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from scripting/Scripting-News

All issues in scripting/Scripting-News

Similar issues

More Content issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.