Arbital Markdown
The Arbital editor uses Markdown syntax for editing the pages. If you’ve used Reddit or any of the StackOverflow, it’s the same syntax. Here is a helpful intro to Markdown syntax.
Arbital Markdown syntax
Arbital adds a few extra features to Markdown syntax.
Table of contents
`` creates a table of contents, like the one above.
Greenlinks
Add note about the Intrasite Link button on the toolbar.
You can quickly link to a page by using id
or, even better, alias
syntax. For example:
Arbital Markdown
⇒ Arbital Markdown
Arbital markdown
⇒ Arbital Markdown
value alignment problem
⇒ Value alignment problemvalue alignment problem
⇒ value alignment problemIf you want to specify what text shows up as the link, use text
. For example:
Custom link
⇒ Custom link
If you link to a page that doesn’t exist, the link will show up red:
Doesn’t exist
⇒ Doesn’t exist
If you want to just create a red link with some text:
create a page for this concept later
⇒ create a page for this concept later
If you want to mention someone use @userId
or @userAlias
:
@1
⇒ @1
@AlexeiAndreev
⇒ @1
NOTE: the user will get an update if the mention is in a comment.
<div><div>
Summaries
You can set the page’s summary, which shows up in greenlink popovers and other places. For example:
Summary of the page goes here. *Markdown* is okay!
Or to set a specific summary:
Very technical summary. *Markdown* is okay!
Make sure that the entire summary block is in a paragraph of its own.
You can create hidden text:
Hidden text goes here.
You can use this for hiding problem answers and asking the user to solve the problem themselves before clicking the button to see the correct answer. Button text is required.
Notes
You can create notes, which are snippets of text hidden behind a question mark. You can put footnotes or other text that might be interesting to some users, but not to everyone. For example:
noteFun note text!
will show up as: noteFun note text!
You can embed votes from other pages. For example:
3r
creates this voting bar:3r
Todos, comments, and fixmes
You can leave todo markers for yourself or other authors. For example:
finish this section
finish this section
This will only appear in the top quality bar when expanded, not the page text. Red links and “todo” markers count towards the todo score, which you will see next to the pages on the Explore and your Profile pages.
Similarly, you can leave comments or fixmes for other authors, but without increasing the todo count. For example:
there has got to be a better metaphor for this
this needs to be fixed, but I've got it
there has got to be a better metaphor for this this needs to be fixed, but I’ve got it
Again, this doesn’t show up for the reader in any way.
questions and path generation
conditional text
LaTeX
If you’re new to LaTeX you may want to read the Wikibooks guide
You can use $ to create inline mathematical expressions, e.g.$ax^2 + bx + c = 0$
will be displayed as: \(ax^2 + bx + c = 0\)
And $$ to create centered math expressions, e.g.$$\lim_{N \to \infty} \sum_{k=1}^N f(t_k) \Delta t$$
will be displayed as: \($\lim_{N \to \infty} \sum_{k=1}^N f(t_k) \Delta t\)$
The editor can get a little slow if you are editing very LaTeX-heavy pages. If this is an issue for you, let us know, and in the meantime you can disable MathJax on the settings page.
Children:
- Arbital Markdown questionnaire
How to ask questions in Markdown.
- Arbital hidden text
How to hide text in Markdown behind a button.
- Arbital page summaries Markdown syntax
How to create page summaries using Arbital’s Markdown syntax.
- Arbital todo
So many things todo!
- Arbital markdown demo
Demo of Arbital’s markdown
Parents:
- Arbital features
Overview of all Arbital features.
@131, these are all the Arbital-specific markdown addons we have.
Is “coment” (below) a typo?
“there has got to be a better metaphor for this %%coment: this supports line breaks, but needs to be its own paragraph. You can vary the number of |s to envelop other similar blocks. ”
Fixed, thanks!
What’s with the %% marks? Can all [square bracket thingies] be turned into percent-demarcated blocks? How do the percent-demarcated blocks work?
It’s a totally made up, arbitrary syntax that makes no sense and NEEDS TO GO.
I mean, I wasn’t going to say it myself, but that was my general impression :-p
(I’m also dubious on the single square bracket, though it seems to be working fine at the moment.)
“$ax2+bx+c=0$ will be displayed as: \(ax2+bx+c=0\)”
Displays instead of
“S ax^2 + bx + c = 0 S will be displayed as: \(ax2+bx+c=0\)”
(Where S = dollar sign, putting commenting syntax ironically duplicates the error.)
The same problem applies to the centered version.
Now, for some reason the editor displays it just fine, but the actual page does not. (At least on my screen.) The same thing occurs with the previewing of comments versus actually publishing the comments.
“Smart links You can quickly link to a page by using ‘id’ or, even better, ‘alias’ syntax. For example:
Arbital Markdown
⇒ Arbital MarkdownArbital Markdown
⇒ Arbital Markdown”Is 3w both the alias and the id?
Thanks for bringing this up. The $ issue is relatively new, since we’ve been changing the editor a lot recently. The
Arbital Markdown
issue is old, and I’ve never got around to it.But both are fixed now! :)
There appears to be an inconsistency in the rendering of this page and its rendering in the preview pane when editing this page. The LaTeX extension behaves differently, so on this page we see only the rendered expressions twice, when what we are meant to see is the markdown and then the rendered version of the equation. But if you go to edit page, in the preview pane it is correct. Is there a way to file a bug?
Thanks for bringing this up. I fixed the core part of the issue: you can now use backticks to escape LaTeX rendering. However, if you use bold, the behavior is still inconsistent between the editor and live view. We’ll fix that in due time.
Usually commenting on the page is fine for reporting issues, but there is also a “Leave feedback about Arbital” button under the quick menu in the bottom right corner.
Is there a way to link to a section within a page? (E.g. for tables of contents.)
Not yet.
There is now! This page even has a TOC.
Does arbital markdown use any of the markdown table formats? Can latex be included within? Is there a way to insert an html table into a page or parse other html?
Good question. We don’t have table or HTML support right now, but I”ll bump up the priority on that.
We do support LaTeX. I think it’s not rendering correctly on Primer on Infinite Series because of
<td>
and other such tags.Tiny but important remark:
It seems weird to me that the links in the TOC are blue, since blue normally means external link whereas green means internal link. But maybe there should be a link color that’s further towards green on the blue-green spectrum of links, for links that are on the page itself? At any rate, making the TOC links greyish or greenish by default seems like a good plan.
Can we add support for colors? I would find it very helpful to be able to color code words that relate to each other, in the way that redpenblackpen and 3blue1brown do.