My gist markdown is not rendering when I embed it. Is this a GitHub issue, or am I doing it wrong?
The gist:
https://gist.github.com/3094145
The non-rendering embedded gist:
http://jsfiddle.net/dJnBg/
Thanks!
*2012-12-11 Update: Today github pushed out a complete rewrite of gist.github.com, and this is no longer a problem. For proof, see screenshot. *
It looks deliberate. It's worth noting that syntax highlighting still works in embeds, but not (alas) markdown rendering.
A potential workaround might be to add additional JS code (after the gist embed JS) that renders the markdown client-side, perhaps via http://www.showdown.im/
I made an issue for myself to do this for the redmine gist embed plugin I wrote.
https://github.com/dergachev/redmine_gist/issues/3
Perhaps by the time you're reading this I got around to tackling this ;)
Related
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!
I like the suggestions when I'm writing HTML and CSS but this is a very annoying thing when I'm writing front matter in a Jekyll page. Is there a way to disable suggestions for anything relating to schema.
It was the liquid plugin I was using, oh the irony.
I come from the world of JavaDocs and love the DX of working on a thoroughly-annotated application after a certain level of complexity.
Being able to hover over and peek all the props (and implied types) of a component with some brief documentation would save me so much time instead of having to open up and read through the whole component. Better yet, running a command to generate a documentation site just like you can with JavaDocs would be dope!
Are there any standards or tools built around creating SvelteDocs? I looked through the VS Code marketplace and didn't see any documentation tooling related to Svelte.
I stumbled upon this question in search of more in-depth documentation for the hover/peek documentation method I've been using. It seems that it is not very well documented (ironically) but it is a part of Svelte language-tools and I've been using it for some time with Svelte for VS Code so I'm sure there was more documentation at some point. The way it's used is as follows in your component. I remember reading somewhere that it needs to be the first thing in your component, but I can't find that source anymore.
<!--
#component
some markdown here
-->
For some reasons the only documentation I can find of it is here. But it provides very nice markdown support so you can craft some very informative hover/peek documentation for your components.
EDIT:
Still can't locate official documentation for the #component commenting feature but realized it is indeed described in the FAQ: https://svelte.dev/faq#how-do-i-document-my-components Does this information belong in the actual docs? Maybe.
After more digging, I found just a couple projects for documenting Svelte.
SvelteDoc Parser -- takes a VueDoc approach, based on JSDoc standards, generates JSON documentation for Svelte components
Svelte-Docs -- documentation in Markdown mixed with Svelte's features, can embed components in the generated doc pages
Both look interesting while taking completely separate approaches to solving the issue of application documentation. Perhaps there's still room to build a CLI-based site generator for the SvelteDoc Parser which could be turned into a VS Code plugin!
It is difficult to find a good one. I recommend
https://github.com/carbon-design-system/sveld
It looks very promising. It offers export in Typescript definitions, JSON and Markdown. In my opinion there is only one critical bug left (Markdown generation) so hopefully it can be used very soon.
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.
Does somebody know a nice way to migrate a Confluence wiki to the Github wiki (aka Gollum) ?
By nice way I mean quick and effective.
You can export whole spaces to html format, and than use pandoc to rewrite pages to ReST|Markdown
I had a similar problem, so I threw together some Python code to do this:
https://github.com/gergelykalman/confluence-markdown-exporter
It is pretty basic but it worked well for me.