Wiki Formatting
This page will introduce you to the various formatting options that are available to structure wiki pages and make it easy for others to find information on it. To learn how to write a great wiki page, also check out Wiki Guidelines.
Contents
Standard Formatting available on Brilliant
Linking to other Wiki pages
You can easily link between wiki pages on Brilliant by using the following syntax:
[[wiki-page-title-or-url|Link Name]]
That example link would link to the "Page Title" wiki page and it would show up in the text as Link Name.
In general, as you start typing the link syntax, we will provide an auto-complete option which will help you choose the correct page to link to. For a working example, suppose we want to link to the page for "linear equations." As we start to enter the syntax, we will see the following:
Clicking on the first option will then produce [[wiki-linear-equations|Linear Equations]]
, which would appear as Linear Equations.
Markdown
See this for more information about Markdown formatting.
You can bold and italicize text using the code of
**bold**
and*italicize*
.Visuals are always helpful. You can include images through the markdown code of
![Image title](Image URL link)
.Please do not link outside of Brilliant as we want the page to be self-contained.
If you can link, you can use the code of[text](URL link)
.
You can also link to wiki pages using the[[wiki-URL
syntax. For more information, see below.To create a new line, but not start a new paragraph, leave 3+ empty spaces at the end of your sentence.
This would allow you to have a new line appear immediately below. If you hit enter but do not add in 3 empty spaces, the sentences will appear on the same line.Lists can be formatted using
1 2 3 |
|
If you are having trouble, you can use 1), 2), 3).
LaTeX
Use \( \LaTeX \) only for mathematical expressions. For a detailed description, see Brilliant Formatting Guide.
Tables
Apart from using the align and array environment in Latex, we also have special formatting to produce simple tables. This code
1 2 |
|
produces this:
1 | 2 | 3 | 4 |
a | b | c | d |
And to avoid the vertical lines above you can add this class to the code
1 2 3 |
|
to produce this:
1 | 2 | 3 | 4 |
a | b | c | d |
See this for more information.
Wiki Specific Formatting Options
1) If you want to separate a page into multiple sections, use two hashtags before the section name, like this: ##Heading
.
For pages with more than one section, a Table of Contents will appear directly above the first heading.
2) To place examples, definitions, theorems or proofs in a box, use the following syntax:
1 2 3 4 5 6 7 8 |
|
That produces output that looks like this:
Example Question. This is the question.
This is the answer to the question, with a detailed solution.
Please explain your steps so that people can follow along.
Code | Output |
[[start-example]] Text [[end-example]] | Text \( \quad \quad \quad \quad \quad \quad \quad \quad \quad \quad \quad \quad \) |
[[start-definition]] Text [[end-definition]] | Text |
[[start-proof]] Text [[end-proof]] | Text |
[[start-theorem]] Text [[end-theorem]] | Text |
3) You can also include information about the page or section using [[start-meta]] ... [[end-meta]]
, which produces output like this:
This information is in a
[[start-meta]]
block.
4) You can hide text using the following syntax:
1 2 3 4 |
|
That produces output that looks like this:
HIDDEN CONTENT
Copyright
Please don't add content to Brilliant that you don't own or didn't create yourself. This includes text and images.
The only exception to this would be if you find an image that is in the public domain in the United States. In that case, feel free to use it where appropriate.
Misconception Wiki Formatting
This is part of a series on common misconceptions.
Is this true or false?
(Add the misconception statement)
Why some people say it's true: (One-line explanation that a beginner might give)
Why some people say it's false: (One-line explanation that a beginner might give)
The statement is \( \color{red}{\textbf{false}}\).
Proof:
(Complete proof of the statement)
Rebuttal: (Address any concerns that people have)
Reply: (Explain why the argument is not valid)
Rebuttal:
Reply:
(If relevant, add in an example problem that demonstrates understanding of this misconception.)
See Also