librecores / librecores-web

LibreCores Web Site
https://www.librecores.org/
Other
33 stars 30 forks source link

Markdown Parser: Synchronize with GH #86

Closed imphil closed 7 years ago

imphil commented 7 years ago

Our MarkDown parser seems to be slightly different than the GitHub one.

See this project: https://github.com/kactus2/kactus2dev/blob/master/README.md https://www.librecores.org/epekkar/kactus2

imphil commented 7 years ago

I guess we'll never be able to get bug-free output unless we go with the exact same solution as GH uses (https://github.com/github/markup).

Idea:

olofk commented 7 years ago

As you say, we will never have bug-free output unless using the same solution as github. The problem is that this isn't enough, as the text might contain internal links that will be broken. The source could also be asciidoc or Restructured Text. (For the latter, I have a similar problem with the README.rst in FuseSoC that is also used by pypi, and has broken links there). Wouldn't the easiest solution be to do a dumb import, but give users the chance to edit and fix-up things. I think it will be a lot of effort spent in vain, trying to emulate other parsers, and editing the raw md/adoc/rst is IMO much nicer than preprocessed html

berndca commented 7 years ago

The a HTML version rendered by GitHub's Markup can be obtained through the AGitHub API see #116 for an example.

@olofk Just change all your links to full URL's and they will work everywhere. For instance replace doc/fusesoc.adoc with https://github.com/olofk/fusesoc/blob/master/doc/fusesoc.adoc

imphil commented 7 years ago

done in PR #123

imphil commented 7 years ago

For example https://www.librecores.org/epekkar/kactus2 shows up correctly now.