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

Support for github flavored markdown #99

Closed
ghost opened this issue Jun 20, 2014 · 6 comments
Closed

Support for github flavored markdown #99

ghost opened this issue Jun 20, 2014 · 6 comments

Comments

@ghost
Copy link

ghost commented Jun 20, 2014

Does mkdocs support Github Flavorded Markdown ?

https://help.github.com/articles/github-flavored-markdown

@edbrannin
Copy link
Contributor

Mkdocs uses Python-Markdown, which has a variety of configurable extensions (plus third-party ones) that can be used to add different parts of GitHub-flavored markdown.

That said, the plumbing isn't quite in place yet to choose which extensions you want enabled. Right now only 4 extensions are enabled, but there's an open pull request (#74) to let us configure more extensions.

@d0ugal
Copy link
Member

d0ugal commented Aug 20, 2014

With #74 merged, I think you should look at third party extensions - hopefully something will provide the features you need. We don't want to implement Markdown extensions in mkdocs.

@d0ugal d0ugal closed this as completed Aug 20, 2014
@edbrannin
Copy link
Contributor

OTOH, it could be worth putting a section in the docs about which extensions exist that could bring it closer to GHFM parity.

@d0ugal
Copy link
Member

d0ugal commented Aug 20, 2014

Good point, that would be a nice pull request :) I'll open this back up for now with that in mind.

@d0ugal d0ugal reopened this Aug 20, 2014
@d0ugal
Copy link
Member

d0ugal commented Oct 8, 2014

Looks like this might do the job, is it a Python-Markdown extension - https://github.com/dart-lang/py-gfm

I've not tried it and thus we can't endorse it on the documentation at the meoment.

@d0ugal
Copy link
Member

d0ugal commented Nov 28, 2014

I'm going to close this for now, a pull request to update the documentation could be useful but the short answer is that we can't support it even if it is provided by an external extension.

@d0ugal d0ugal closed this as completed Nov 28, 2014
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

2 participants