-
Notifications
You must be signed in to change notification settings - Fork 408
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
Export README.md from .org for cljdoc #518
Comments
This sounds like a good idea! @dakrone do you have any preference of an approach. I've thought about a few ways to go about this.
Ultimately, I think this depends on having the maintainer have final weigh in on the workflow. @dakrone if there's one strategy you prefer, I could take a stab at doing the work. :) |
I don't mind switching the readme to Markdown, as not everyone uses org-mode (even though I enjoy Org more than Markdown :)). @rymndhng go ahead and do the conversion! |
BTW pandoc can covnert org-mode to markdown, I believe. |
https://cljdoc.org/ is a popular single-source-for-all-libs documentation hub so it would be ideal if the much used clj-http showed up well there. However it doesn't currently because cljdoc currently only supports .md and .adoc files while here we have an .org.
A solution would be to either export .md from the .org file (perhaps in a git push hook?) or to add .org support to Cljdoc.
The text was updated successfully, but these errors were encountered: