Markdown
Markdown
Markdown is an easy and powerful way to format your descriptions and long text fields using simple, natural syntax.
The basics
-> Creates italic and bold
-> Creates an inline link: Kumu
Note that inline links always open the website in the same tab and direct your viewer away from your Kumu map. If you wish to open the link in a separate tab, you can use the following HTML syntax:
<a href="https://kumu.io" target="_blank">Kumu website</a>
Replace the URL with your own and swap the word "Kumu website" for any word(s) you'd like your viewers to click. Make sure that target= stays the same.
-> Creates an auto-generated link: https://kumu.io
Lists
Looks like:
Milk
Cookies
Marshmallows
Looks like:
California
Texas
New York
Links within your account
We also support linking to elements, connections and loops (even other maps in your account).
You can use the following syntax:
Selectors
Replace link text
with the text for your link, and replace selector
with any valid selector.
Maps
Replace link text
with the text for your link, and replace map-slug
with the slug of your map.
Views
Replace link text
with the text for your link, replace map-slug
with the slug of your map, and replace view-slug
.with the slug of your view.
Images
Replace alt text
with an image caption that screen readers can read, and replace image-url
with a link to your image.
Widgets
See our guide to widgets to learn more about embedding videos, podcasts, slideshows, and other interactive content inside markdown.
Headings
Looks like:
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Learn how to create anchors that skip to certain sections of your map description with this guide.
Code
Simply indent lines with four spaces or wrap the code with three backticks:
Looks like:
Blockquotes
Looks like:
Add quote text here
Tables
If you are using Markdown in the Description column of an import, you will have to use the HTML table tag rather than the usual Markdown syntax. Make sure to remove all line breaks from your HTML, or your table will render with a large white space above it.
<<<<<<< HEAD
542c98f (GitBook: [#18] fixes some busted content in markdown docs)
``` ======= | One | Two | Three | | ----- | ------ | ----- | | Blue | White | Gray | | Green | Yellow | Red |
Horizontal Rules
Now you know the basics of formatting with markdown! For more information, visit Daring Fireball's markdown syntax documentation.
Inline HTML
Kumu's markdown editor also recognizes a limited amount of inline HTML.
Learn how to create anchors that skip to certain sections of your map description with this guide.
Here are the tags you can use in Kumu, anywhere that accepts markdown:
And here are the HTML attributes that use can use for each tag:
LaTeX
Good news for people using Kumu in science, math, or academia—anywhere you write Markdown in Kumu, you can also write LaTeX to include equations!
You can write LaTeX inline or on its own separate line. To write inline, put two dollar signs on either side of your LaTeX code, like so:
Here's what you would see:
Or, for more complex expressions, you can write inside a codeblock marked as latex
, like so:
Here's what you would see:
Kumu uses a tool called KaTeX to render these equations. For a full list of supported equations, visit the KaTeX docs.
Last updated