Skip to content

feat: render READMEs in ORG format, better fallback if not MD#211

Draft
mortenpi wants to merge 1 commit into
masterfrom
mp/org
Draft

feat: render READMEs in ORG format, better fallback if not MD#211
mortenpi wants to merge 1 commit into
masterfrom
mp/org

Conversation

@mortenpi
Copy link
Copy Markdown
Member

  1. Uses Org.jl to render fallback docs from README.org files a bit better.
  2. Readmes without extensions will be rendered as <pre> text.
  3. Readmes that have an unknown extension will also get rendered as <pre>, but also have a warning box (content and styling TBD)

On the JuliaHub package page, Bumper (which has a README in org format) renders pretty well (although not perfectly):

image

The Documenter fallback might need a bit of work:

image

But it is better than the status quo:

image

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

Successfully merging this pull request may close these issues.

1 participant