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

Leverage more markdown where we can #42

Closed
richsalz opened this issue Feb 22, 2022 · 4 comments
Closed

Leverage more markdown where we can #42

richsalz opened this issue Feb 22, 2022 · 4 comments
Assignees

Comments

@richsalz
Copy link
Contributor

The Tao is turned from markdown into HTML by the wagtail plugin. We should leverage more of its (limited?) capabilities in the document, such as

  • Markdown links not a and href tags
  • Auto-numbering of the table of contents and items
  • Better URL referencing, the [foo](https://foo...) or the equivalent that is supported, if anything.
@richsalz
Copy link
Contributor Author

Please re-open this, and assign it to @ghwood . I fixed the stuff I could, now it's up to him and wagtail knowledge :)

@nllz nllz reopened this Mar 17, 2022
@larseggert
Copy link
Member

Specifically:

  • links should use Markdown syntax (and not <a href>)
  • tables should use Markdown (and not HTML)

Also, the CI should validate that the Markdown or at least the final HTML are correct - just glancing at the Markdown at the moment I see several things that are clearly broken (<a href="#2-2-4"/>mentioned above</a>, <a href="#https://www.rfc-editor.org/info/bcp97">, etc.)

@richsalz
Copy link
Contributor Author

richsalz commented Apr 7, 2022

@ghwood there are dozens of things like

<a href-"#http.....

Looks like a find/replace went haywire?

@ghwood
Copy link
Contributor

ghwood commented Apr 7, 2022

Apologies: that's a broken pattern I introduced and my (clearly insufficient) checks did not catch. I agree about doing a better job of validation going forward. I've submitted a PR to fix this specific issue as a quick fix.

I'll submit further PRs to markdown-ify the external links and tables.

@nllz nllz closed this as completed Sep 9, 2022
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

4 participants