Skip to content
/ ricky Public

Ruby Wiki Engine supporting multiple markup formats including Markdown, MediaWiki, reStructuredText, and more.

Notifications You must be signed in to change notification settings

phase/ricky

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

ricky

ricky is a Ruby wiki engine that supports various types of markup formats using GitHub's markup.

Features

  • Custom Themes: Any HTML file can become a theme in seconds!
  • Arbitrary Files: All files in wiki/ will be hosted.

Use

ruby ricky.rb theme.html

In a folder called wiki/, create files such as test.md and they will be rendered when you go to localhost/test.

The best way to version control your files is to make a git repository in wiki/, you can then upload this to GitHub and have you wiki be open source. Add a Heroku hook and bam, instant wiki anyone can edit.

Themes

Themes are normal HTML documents that contain tags that are replaced when the page is rendered.

  • {% title %} will be replaced with the title of the page.
  • {% content %} will be replaced with the content of the page.

About

Ruby Wiki Engine supporting multiple markup formats including Markdown, MediaWiki, reStructuredText, and more.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published