Markdown support¶
Triply allows rich text formatting to be used in the following places:
- Dataset description
- Account description
- Saved Query description
- Data Story elements
- Site welcome message
The following Markdown elements are supported:
Headings¶
Headings are used to divide a text into different sections. The hash
character (#) at the beginning of a line indicates a heading is
used. Multiple hash characters indicate nested headings.
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Text styling¶
| Style | Syntax | Output |
|---|---|---|
| Bold | **bold** |
bold |
| Italic | _italic_ |
italic |
| Strikethrough | ~~strikethrough~~ |
~~strikethrough~~ |
Hyperlinks¶
| Style | Syntax | Output |
|---|---|---|
| Raw URL | <https://triply.cc> |
https://triply.cc |
| Labeled URL | [label](https://triply.cc) |
label |
Notice that URLs can also be relative. This allows you to refer to other datasets, saved queries, etc. by using relative paths.
Code¶
There are options for formatting in-line code as well as multi-line code blocks.
In-line code¶
Code can also be used in-line with single backticks:
Use `code` inside a sentence.
Multi-line code blocks¶
Multi-line code blocks start and end with three consecutive backticks. The following Markdown denotes a SPARQL code block:
select * { graph ?g { ?s ?p ?o. } }
The above is rendered as follows:
select * {
graph ?g {
?s ?p ?o.
}
}
Code language¶
The opening backticks are optionally following by the name of the code language. The following code languages are supported:
| Language | Syntax |
|---|---|
| SPARQL | sparql |
| Turtle | ttl |
| TypeScript | typescript |
| R | r |
| Python | python |
The other supported languages are: Bash (bash), C (c), C++
(cpp), C# (csharp), Extended Backus-Naur Form (ebnf), Go (go),
Haskell (haskell), Java (java), JavaScript (javascript), LaTeX
(latex), Makefile (makefile), Markdown (markdown), Objective C
(objectivec), Pascal (pascal), Perl (perl), Powershell
(powershell), Prolog (prolog), Regular Expression (regex), Ruby
(ruby), Scala (scala), SQL (sql), Yaml (yaml).
Related¶
- Build a data story — story paragraphs are written in this Markdown
- Add data — a dataset description is too