This is an old revision of the document!


Editing the Wiki

This documentation is a Wiki, which means anyone can edit it.

Simply click the edit button at the bottom of every page. The first time you will need to create a Wikidot account, which takes just a minute.

You are very much encouraged to help us improve this documentation.

Even small contributions can have a large impact and make lots of new user's life easier.

In order to edit the wiki, you will need to learn a few things, like how to write in Wiki Markup language.

You can just write plain text, and it will be displayed, but there are ways to make it more useful :

It is fairly simple, and you can very easily just copy the way it is done on existing pages.

A good starting point is the Wikidot Wiki Syntax documentation.

Text

You can just write text and it will be displayed as-is.

To make sure lines are separated, leave an empty line between them, like this :

code You can just write text and it will be displayed as-is.

To make sure lines are separated, leave an empty line between them, like this :
code

Headers

You can add headers to structure your page ( like on this page ), by doing : 

code

code

The number of signs determines how big the header is, the page title has one sign, and the rest get more and more as they go deeper.

~~~~

= One plus header
== Two plus header
=== Three plus header
==== Four plus header

~~~~

To insert a link into a page, simply to :

code This is a link : link name.
code

To insert a link to a page on the wiki itself, do : 

code This is a link to the Editing the wiki page.
code

Images

To insert an image, do :

code image.png code

A nicer way of integrating images is to do the following :

\n

A laser power supply

They use very high voltages and are dangerous

code \n

A laser power supply

They use very high voltages and are dangerous

code

Which gives you a box, labels, and float control.

Note that you can change the floats to middle to make the image centered, or left to make it float to the left.

Commands

If you are mentionning a G-code or a configuration option, we have a special syntax that makes it look like-this, simply do :

code The g1 G-code is pretty cool.
code

Code

To insert code into the page, you can use the special code tag :

code code

  1. This is redundant

Some code
code code

It will be formatted as mono-space, and will not be interpreted as Wiki markup.

Boxes

We have a special syntax for “notes” that makes nice colored boxes, like this :

Shiny box

With lots of yummy information

The syntax is : 

code

Shiny box

With lots of yummy information

code

You can change the color of the box by changing bs-callout-success to other values : 

Table of contents

If the page has many headers, you can add a table of contents to it to make it easier to navigate, by doing : 

code toc code

You can right-justify it by doing :

code toc code

Here is what it looks like : 

toc

Lists

You can make nicely formatted lists by doing :

code

  • Item one
  • Item two
  • Item three

code

They then look like this :

  • Item one
  • Item two
  • Item three

HTML

You can insert raw HTML into the page by doing :

code html <h1>Custom HTML</h1>
<p>Something else</p>
<img src=“anything.png” alt=“hello ;-)”/>
html code

This is in particular useful to insert Youtube videos and the like.

Page formatting

The Smoothie wiki uses Bootstrap for formatting, which means you can use it's nice features to make your pages look nicer.

For example you can format your page with two columns : 

~~~~

One column
Another column

~~~~

You do this by writing :

code

One column
Another column

code