docs
This commit is contained in:
parent
ab644b8910
commit
ac39d2708e
|
@ -1,9 +1,10 @@
|
|||
GOALS:
|
||||
simplicity
|
||||
as little boilerplate and magic as possible
|
||||
multithreaded dispatch
|
||||
|
||||
plugins are located in plugins/
|
||||
|
||||
focus: as little boilerplate as possible, without being arcane
|
||||
|
||||
TODO: documentation :3
|
||||
|
||||
input:
|
||||
nick -- string, the nickname of whoever sent the message
|
||||
channel -- string, the channel the message was sent on. Equal to nick if it's a private message.
|
||||
|
|
|
@ -0,0 +1,36 @@
|
|||
== Welcome ==
|
||||
|
||||
Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
|
||||
|
||||
=== Wiki features ===
|
||||
|
||||
This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
|
||||
|
||||
The wiki itself is actually a hg 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.
|
||||
|
||||
Go ahead and try:
|
||||
|
||||
{{{
|
||||
$ hg clone http://bitbucket.org/Scaevolus/skybot/wiki/
|
||||
}}}
|
||||
|
||||
Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
|
||||
|
||||
=== Syntax highlighting ===
|
||||
|
||||
You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
|
||||
|
||||
Here's an example of some Python code:
|
||||
|
||||
{{{
|
||||
#!python
|
||||
|
||||
def wiki_rocks(text):
|
||||
formatter = lambda t: "funky"+t
|
||||
return formatter(text)
|
||||
}}}
|
||||
|
||||
You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
|
||||
|
||||
Have fun!
|
||||
|
Loading…
Reference in New Issue