I have a markdown created using the (new) RStudio quarto engine. I want to upload the .md in a Github repo. However, few elements render properly. For instance, many tables do not render, some markdown code renders as is (e.g. :::{.column-page}).
This is my first time using quarto. If I want to create an r markdown that is as compatible with Github markdown engine as possible, what should I do (I don't have to stick with quarto)?
You can use Quarto to convert your input to GitHub Flavored Markdown (gfm) by using
format: gfm
It should be possible to use the output with both Quarto and GitHub.
See also the Quarto docs on gfm.
You can check out GitHub's documentation on what syntax it supports for its Markdown engine, Basic writing and formatting syntax, which though covers a lot of scenarios doesn't out-of-the-box support engines like the RStudio Quarto one you mention.
Another option you have is to use GitHub Pages, where you can generate a static site using tools like Jekyll and some custom plugins for your use case, to generate a static site and upload it.
I don't know off the top of my head specific plugins for RStudio Quarto, but I'd imagine you should be able to find one of the static site generator tools will support it. Hope this helps!
Related
Many people document applications in the source files themselves, e.g. https://github.com/docopt/docopt.cpp . In the spirit of DRY (don't repeat yourself), I would like source documentation to appear in my README.md on GitHub (auto-generated from the source.) I see many user-community questions about including README.md in output documentation, but nothing about going the other way, src documentation -> README.md. doxygen seems like the tool that should own this space, but has no output formatters for markdown files.
Does it make sense to anybody else to create an output formatter for markdown?
Apparently it does make sense, and has been proposed before, as well as some bolt-on solutions developed: https://github.com/doxygen/doxygen/issues/6760
I am trying to import my issues from Notion to GitHub but finding the markdown system really hard to write/preview. Writing on markdown is still fine but if I want to see the preview, there's tons of back and forth.
Wondering if someone has solved this issue with an external plugin?
Check out GitHub Writer, which has a Chrome and Firefox extension.
I just a newbie on github. I'm doing my Project with the Markdown file type on that. So, can you show me where can I find full of Markdown Documentation?
Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.
You can find this:
https://guides.github.com/features/mastering-markdown/
The best place to learn about markdown would be https://guides.github.com/features/mastering-markdown/
Another Markdown reference I have found useful is https://www.markdownguide.org/basic-syntax . This documentation gives reference to Markdown code next to HTML code that helps users understand the syntax more easily if they are familiar with HTML and its outputs.
How can I show formatted math expressions in Bitbucket or github markdown?
This feature is highly requested and have been under development for years now. There does not seem to be a decent solution for it yet.
Formatted math is supported in reStructuredText and I can use it as a last resort. But as markdown gains popularity I would rather stick to it than use yet another markup language.
Bitbucket's (and GitHub's) Markdown does not currently support formatted math expressions. A good workaround I discovered that works with both is to use codecogs to convert my LaTeX math expression into a hosted image and use its URL to embed it in my Markdown document.
Example:
Go to codecogs and enter your LaTeX equation in the text box.
\zeta(s) = \sum_{n=1}^\infty \frac{1}{n^s}
Right click the Click here to Download Image (GIF) link shown under the text box and copy the link's address. Then, embed the URL in your markdown document as an image:
The image should show in your formatted Markdown document like:
This method also works with GitHub and any Markdown processor that supports externally hosted images.
Also, mathURL offers a similar service and a nice interface but does not support https (can't use with GitHub).
At least in the past few years, there has been little progress in this area. You can only get unclear formulas through pictures.
But GitLab supports mathematical formulas, you need to note that gitlab uses its own flavored formula delimiters instead of the most general dollars.
inline: $...$
display: $$...$$
Although you can solve this problem with the following vscode extension, it is still not elegant enough.
https://github.com/yzhang-gh/vscode-markdown
https://github.com/goessner/mdmath
github supports several markup languages, one of which is Emacs org mode docs.
But it always look ugly with the default CSS file(much better than
the default one in built-in org mode, though.
Also it seems that the
source code block does not have syntax highlight either.
So is it possible to make it more beautiful with some minor changes in org files? Or can you give me some advice or good practice?
Github uses org-ruby to convert org-mode to html. It appears that recent versions of org-ruby support both lower case org-mode keywords and syntax highlighting in the source code blocks (among other nice things). Until it is upgraded in the official Github, it looks like the only options are either to use upper case BEGIN_SRC/END_SRC or export your org files to html/md in emacs with any options/css/etc you like and post the resulting files on Github.
Githubs Org-Mode support is upgraded but #+TITLE: is unsupported, like links that are mostly bugged. So it works mostly.