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
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'm using the GitHub flavoured Markdown on the GitHub wiki, and would like to somehow "tag" paragraphs in need of rewriting or elaboration.
My first thought was to write some kind of note above the paragraph and colour that note red (or any colour besides black, really) for quick recognition, but it appears that Markdown does not support colouring text. I'm already using bold to emphasise other things, so I would like to avoid using that.
I realise a similar question (Semantic tagging in Markdown) has been asked previously, but that did not deal with to-do tags. I guess what I'm really looking for is a way of doing this based on someone else's experience as there is no specific syntax for accomplishing what I'm trying to do.
Two questions, then:
1) Why doesn't Markdown support colouring text?
2) Is there any semantically correct way of "tagging" a to-do in a Markdown wiki? If not: any suggestions?
As-is, Markdown is meant to be more of a replacement syntax for a language such as HTML and, for the most part, doesn't determine any styling for content.
If you want to "tag" something as a to-do item, you could make a line linking to an itemized task list on its own separate to-do page.
'pure' markdown is supposed to be at least fairly style-independent (as with most markup languages). It does provide the pragmatism of inline raw html/latex which if you are only targetting one of them (I'm assuming html given the github tag) are probably the easiest way to do it.
Not within markdown markdown. The closest is the class support that various flavours of markdown have added as extensions to the language (personally I use pandocs, although the link you provided offers a couple of extra options). These are obviously harder to use if you are targeting github since you can't control the variant in use.
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.
I have to maintain a huge set of training material in forms of slides.
At a first glance, I've noticed there's no support for version control in OpenOffice OOImpress (but I might be wrong on this).
Which tool should I use to easily maintain my training material?
I thought about using LaTeX + Beamer so that I can easily put under version control the source code for the slides, but also non technical people should be able to update the material and I would prefer not to force them to learn LaTeX.
My preferred way of writing presentations is now using a Trac wiki with the S5 plugin.
S5 is a slideshow format that turns HTML+CSS+JS into a slideshow you can run in your browser. You can see an example slideshow here.
Instead of writing the S5 HTML by hand, I use Trac's S5 plugin to convert wiki syntax (similar to mediawiki syntax) to an S5 presentation. So a wiki page like this:
[[S5(theme=yatil)]]
= My presentation =
'''November 18 2009'''
* Steven Kryskalla
* skryskalla#gmail.com
* http://lost-theory.org
== Intro ==
* Topic 1
* Topic 2
* etc.
== How to X ==
First, install and configure...
{{{
#!python
#this turns into syntax highlighted code
}}}
== Resources ==
* http://www.example.com/
Turns into a slideshow with 4 slides. The == Headings == start a new slide, and the body of each slide can be text, syntax highlighted code, bulleted lists, numbered lists, images, tables, etc.
The wiki has built in version control so you can diff, revert changes, etc.
It probably wouldn't be that difficult to re-use the wiki formatter and S5 code to create a command line program that turned a text file into a presentation. That would allow you to keep the slide in your own version control system (svn, hg, etc.).
I sounds like you're looking for a Digital Asset Management System. You could try something like SVN with one of its GUI tools, or get something more involved like Canto's Cumulus.
Cumulus is something our company has used in the past, we no longer have a need for the system so my knowledge on the different kinds of systems out there is pretty dated.
Why not simply put OOImpress documents under something like Subversion or Git and use TortoiseSVN to let end-users manage the version-control bit.
Any good CMS offers revision control as well. But in general, any source control system can version any file, diffs won't be easy to do, however, since these items are in xml, they won't diff well.
This is an old question, but because I have run across the same issue recently, I would like to share solutions I considered or used, in the hope it may be useful for the next person who runs across this question:
The simplest solution is to use Powerpoint or similar software online, converting LaTeX to images, and to use their built-in version control. Answers to this question detail how you can diff such versions.
You could use a Markdown-based solution. My eventual choice was AsciiDoctor because it's free, well-maintained, and does what I need. Madoko looks even better, and is more oriented towards LaTeX, but does not seem to be maintained. Both solutions are based on the reveal.js framework. There is also GitPitch which is a git-based Markdown solution, but its freemium model puts me off. Fusuma is another solution a Google-search suggested.
Do any WYSIWYG editors exist that work natively in Markdown? (any Platform/Language)
...So consumers don't have to see the code behind, just work in an MS-Word like interface.
An assisted MarkDown editor where you're viewing and editing the Markdown-source (like the one I'm writing this question with) would also be okay.
There is the Wysiwym Markdown Editor (The one we're using here). It shows live-markdown though, rather than masking it. I think the great thing about Markdown is that just about anybody can understand the basics of it.
This is the only editor I know of. After doing a cursory browsing of Google it appears to be one of the few, if not the only one in wide-spread use at the moment.
A large list of Markdown implementations at the Markdown Wiki.
Perl
PHP
Python
Ruby
C
C#
Java
Javascript
Common Lisp
Lua
Haskell
And:
Blog Software
Wiki Software
Text Editor
Desktop Software
Other Tools