Xiki Project

Summary

Xiki is short for "Executable Wiki". It has wiki syntaxes for executing things, like shell commands, code (in various languages), sql, and even general-purpose menus you can define. Xiki runs mostly as a text editor plugin.

Links

Xiki has wiki syntaxes for

Examples

  > A heading

- A bullet point

$ ls -l

$ ls -l | -rw-r--r-- root wheel 2k May 22 2012 passwd | -rw-r--r-- root wheel 1k May 22 2012 group

$ my-other-shell-command | Results are inserted underneath when you | double-click (or type control-enter) on the command. | Then you can double-click again to collapse the output.

/tmp/

/tmp/my-other-diretory/ - my-file.txt

/tmp/my-other-diretory/ - my-file.txt | Contents of | the file.

/tmp/my-other-diretory/ $ ls | file-in-this-dir.txt | and-another.txt

select * from users

select * from users/ | id name description | 1 Sam Wears sunglasses | 2 Steve Edit rows and double-click to save back to the db

puts 1 + 2 # Double-click on this ruby code to run it

puts 1 + 2 # Double-click on this ruby code to run it 3

html/ | <h1>Double-click on one of these lines</h1> | <p>to show this html in the browser</p>

css/ | h1 { color: red; } | body { | font-family: arial; | font-size: 15px; | }

js/alert('hi') // Double-click to run this javascript in your browser

dom/ - body/ - h1/ | Explore and edit the DOM of the current | page in your browser - div/

r/User.first

r/User.first | --- !ruby/object:User | attributes: | id: 1 | name: Steve | details: Runs code in rails apps. | more: You can edit ActiveRecord models and double-click again to save.

couchdb/ - my_db/ - id_of_a_document/ | name: Steve | description: Edit and double-click to save - my_other_db/

bootstrap/ > Heading This will be rendered in the browser as a bootstrap layout.

bootstrap/ > Heading This will be have (blank line) > Another Heading Two sections

bootstrap/ > Heading This will be have > Another Heading Two columns, because blank line omitted

rails/ + start/ - generate/ + app/ - model/house/ > Example fields | name:string | details:text | price:decimal | purchased_at:datetime | user:references + resource/ + controller/

Xiki has menus for

Misc Features

Supported Editors

Invitation from the Author

Ruby Conf 2012 Xiki talk


CategoryWikiImplementation


EditText of this page (last edited December 7, 2012) or FindPage with title or text search