-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Feature request: RMarkdown Support #1553
Comments
@ogurcan What would be needed for this? Availability of |
I am not an expert but I suppose yes, |
I have no experience with RMarkdown, but would it be possible to do this by tweaking the configuration of pandoc here? |
Seems like |
I guess it would be nice if Gollum supported Rmd out of the box so +1 for this since I use R. Afaict - the only difference between md and Rmd is that the code chunks are defined a little differently. Rmd is interesting particularly because, like Org mode documents (and unlike Jupyter notebooks in general), it is possible to store code notebooks in a text markup format, enabling version control. P.S I've ~almost decided in using Gollum for my personal wiki. Being an Emacs + Org mode guy - I'm swayed by the git integration and the way Org files are directly rendered. Maybe this would also help with clues > https://github.com/chasberry/orgmode-accessories |
The main development principle I would like to maintain is: gollum is not responsible for rendering documents itself. That means we need a 'third party' library or app like Pandoc to function as a renderer. Just found these:
@shrysr thanks for pitching in. Since the main business of RMarkdown involves parsing code blocks, we may have to skip Gollum's codeblock rendering step altogether for RMarkdown documents (using the Re: your other comments, @shrysr: great to have you aboard! If you have any specific ideas of how org-mode support could be improved, feel free to open new issues -- although see again the design principle I outlined above: gollum's support of org-mode is limited by what the rendering gem, in this case org-ruby, can do. It would be great to know if this is still up to date, if there are alternatives, and if we're currently using all its features. |
Anyone interested in helping with this please see gollum/gollum-lib#397 |
@ogurcan or anyone else watching this thread: could you give us some feedback on how, as an RMarkdown user, you would expect this to work in gollum? When viewing a page, should all the RMarkdown blocks already be rendered (also displaying the original R code, unless |
Typically, it is the first case. You can even by default hide the original R code and make it optional to show it as it fits better for a Wiki-like usage of RMarkdown. |
After having experimented with this a while, @bartkamphorst and I have concluded the following:
@ogurcan and anyone else interested in RMarkdown support: does this sound like an acceptable solution? Any feedback and help is very welcome! EDIT: it now seems we can use Rserve to return |
I think that this sounds like a fair and acceptable. Thanks in advance! |
Proof of concept in this branch: https://github.com/dometto/gollum/tree/rmarkdown To try it:
Explanation:
An rmardown block in gollum is any codeblock that declares its language to be of the form
The result is e.g. this (since this runs in JS, the codeblocks are displayed "raw" first and then replaced with the rendered blocks from Possible problems:
|
It would be great if Gollum support RMarkdown and allow creating Wikis using RMarkdown.
The text was updated successfully, but these errors were encountered: