RISE4FUN

Tutorials are a great way to increase traffic for your tool. We strongly recommend to author one or more tutorials for your tool.

syntax

The tutorials use the markdown syntax that runs in stackoverflow.com. You can find plenty of excellent markdown editors for most platforms.

When a code block contains a single word, say "foo", rise4fun will look a sample called "foo" in the list of samples attached to the tutorial. If it finds it, it will automatically insert the source of the sample in the resulting HTML and create a link to open it in the editor.

# this is a title
# this is a sub title

this is *italic*, **bold** or ***both**

    indentext text paragraphs are treated as code sections

this is a bullet list
* bullet 1
* bullet 2

This is my snippet of code...

    mysample

This is an hyperlink pointing to the [official markdown documentation](http://daringfireball.net/projects/markdown/).

You can also use the Markdown back-ticks, like `this` and `x + y`. If you have a syntax highlighter (that is, if you respond to the /language action), these will be colored appropriately. You can show a syntax highlighted code block like this:

```
var x := y + z;
```

It is important that you have a blank line before the starting ``` and after the ending ```. To provide a "load in editor" button for the code, so that the reader of your tutorial can try it out with your tool on rise4fun, add the {.edit} attribute:

``` {.edit}
var x := y + z;
```

If what you want to display in the tutorial is not the same as what you want the editor to bring up, you can use two separate code blocks, marking the first with with {.editonly} attribute:

``` {.editonly}
// This code will show in the editor if the user clicks "load in editor"
method Main() {
  var y, z := 85, 1900;
  var x := y + z;
  print x, "\n";
}
```

```
// This code will show in the tutorial
var x := y + z;
```

Make sure you have that blank line between the two code blocks.

math equations

rise4fun uses MathJax to render TeX or LaTeX math equations into beautiful maths. The default math delimiters are $$...$$ and \[...\] for displayed mathematics, and \(...\) for in-line mathematics. Note in particular that the $...$ in-line delimiters are NOT supported.

\[\begin{aligned} \dot{x} & = \sigma(y-x) \\ \dot{y} & = \rho x - y - xz \\ \dot{z} & = -\beta z + xy \end{aligned} \]

becomes

\[\begin{aligned} \dot{x} & = \sigma(y-x) \\ \dot{y} & = \rho x - y - xz \\ \dot{z} & = -\beta z + xy \end{aligned} \]
rise4fun © 2017 Microsoft Corporation - terms of use - privacy & cookies - code of conduct