Mercurial > public > ostc4
comparison wiki/Original HELP page.md @ 38:5f11787b4f42
include in ostc4 repository
| author | heinrichsweikamp |
|---|---|
| date | Sat, 28 Apr 2018 11:52:34 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 37:ccc45c0e1ea2 | 38:5f11787b4f42 |
|---|---|
| 1 # Welcome | |
| 2 | |
| 3 Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it. | |
| 4 | |
| 5 ## Wiki features | |
| 6 | |
| 7 This wiki uses the [Markdown](http://daringfireball.net/projects/markdown/) syntax. The [MarkDownDemo tutorial](https://bitbucket.org/tutorials/markdowndemo) shows how various elements are rendered. The [Bitbucket documentation](https://confluence.atlassian.com/x/FA4zDQ) has more information about using a wiki. | |
| 8 | |
| 9 The wiki itself is actually a mercurial repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately. | |
| 10 | |
| 11 Go ahead and try: | |
| 12 | |
| 13 ``` | |
| 14 $ hg clone https://JeanDo@bitbucket.org/JeanDo/ostc4/wiki | |
| 15 ``` | |
| 16 | |
| 17 Wiki pages are normal files, with the .md extension. You can edit them locally, as well as creating new ones. | |
| 18 | |
| 19 ## Syntax highlighting | |
| 20 | |
| 21 | |
| 22 You can also highlight snippets of text (we use the excellent [Pygments][] library). | |
| 23 | |
| 24 [Pygments]: http://pygments.org/ | |
| 25 | |
| 26 | |
| 27 Here's an example of some Python code: | |
| 28 | |
| 29 ``` | |
| 30 #!python | |
| 31 | |
| 32 def wiki_rocks(text): | |
| 33 formatter = lambda t: "funky"+t | |
| 34 return formatter(text) | |
| 35 ``` | |
| 36 | |
| 37 | |
| 38 You can check out the source of this page to see how that's done, and make sure to bookmark [the vast library of Pygment lexers][lexers], we accept the 'short name' or the 'mimetype' of anything in there. | |
| 39 [lexers]: http://pygments.org/docs/lexers/ | |
| 40 | |
| 41 | |
| 42 Have fun! |