Coder Social home page Coder Social logo

phymucs / instiki Goto Github PK

View Code? Open in Web Editor NEW

This project forked from parasew/instiki

0.0 1.0 0.0 96.51 MB

a basic wiki clone so pretty and easy to set up, you’ll wonder if it’s really a wiki.

Home Page: http://instiki.org

JavaScript 84.35% Ruby 9.32% Python 0.08% PHP 0.08% CSS 1.71% HTML 4.45% Batchfile 0.01% Dockerfile 0.01%

instiki's Introduction

Instiki

Instiki is a wiki clone so pretty and easy to set up, you'll wonder if it’s really a wiki. Runs on Rails and focuses on portability and stability. Supports file uploads, PDF export, RSS, multiple users and password protection. Some use Instiki as a CMS (Content Management System) because of its ability to export static pages.

Instiki lowers the barriers of interest for when you might consider using a wiki. It's so simple to get running that you'll find yourself using it for anything -- taking notes, brainstorming, organizing a gathering.

Supported Platforms

Instiki only requires a working Ruby installation (it includes all other dependencies). Any OS that can run Ruby can run Instiki - that includes Windows, Linux, Mac OS X and most known Unix flavors.

3 easy Steps to get the Instiki experience

Step 1. Get Instiki and run "ruby bundle install --path vendor/bundle" Step 2. Run "instiki" Step 3. Chuckle... "There's no step three!" (TM)

Details

You need at least Ruby Version 2.0 installed on your System. Instiki is known to work well with Ruby 2.0-2.6. The second dependency is a Database System, but don't worry, the default sqlite3 will be installed for you, if it's not already installed. You can also use any other database system (MySQL, PostgreSQL, ...) supported by Rails.

Deploy to Heroku

  • git clone https://github.com/parasew/instiki.git
  • cd instiki
  • heroku create [APPNAME]
  • mv Gemfile Gemfile.orig
  • git mv Gemfile.heroku Gemfile
  • git mv Gemfile.lock.heroku Gemfile.lock
  • git commit -m "Setup for heroku"
  • git push heroku master
  • heroku config:set RAILS_ENV=production
  • heroku run rake db:migrate

If you are on Windows

If you are on Mac OSX

On Snow Leopard (10.6) or later, you are all set.

  • run "sudo gem update --system" via the command-line.
  • run "ruby bundle install --path vendor/bundle" in the instiki directory.
  • run "ruby instiki" and there you go!

If you are on Linux

Any other System

  • get Ruby for your System, compile if necessary: http://ruby-lang.org

  • Depending on the version of Rubygems that came with your Ruby, you may need to

    sudo gem update --system

  • get SQLite or compile from http://sqlite.org (you can also use mysql or any other supported database system if you want)

  • run "ruby bundle install --path vendor/bundle"

  • run instiki

You're now running a perfectly suitable wiki on port 2500 that'll present you with one-step setup, followed by a textarea for the home page on http://localhost:2500

Features

  • Regular expression search: Find deep stuff really fast
  • Revisions: Follow the changes on every page from birth. Rollback to an earlier rev
  • Export to HTML or markup in a zip: Take the entire wiki with you home or for reference
  • RSS feeds to track recently revised pages
  • Multiple webs: Create separate wikis with their own namespace
  • Password-protected webs: Keep it private
  • Authors: Each revision is associated with an author, so you can see who changed what
  • Reference tracker: Which other pages are pointing to the current?
  • Five markup choices: Markdown-based choices [http://daringfireball.net/projects/markdown/syntax]: Markdown+itex2MML (the default; uses itex2MML) Markdown+BlahTeX/PNG (requires blahtex and a working TeX installation) Markdown Textile [http://www.textism.com/tools/textile] RDoc [http://rdoc.sourceforge.net/doc]
  • Support for Math (using itex syntax)
  • Support for WYSIWYG SVG editing -- embed SVG graphics right in your wiki page.
  • Embedded webserver: uses Mongrel (if installed), or the bundled WEBrick webserver (if not).
  • Internationalization: Wiki words in any latin, greek, cyrillian, or armenian characters
  • Color diffs: Track changes through revisions
  • Runs on SQLite3 per default, can be configured to run on PostgreSQL, MySQL, DB2, Firebird, Openbase, Oracle, SQL Server or Sybase
  • Optional support for Tikz pictures. Requires an optional install. See here for details.

Command-line options:

  • Run "ruby instiki --help"

History:

  • See CHANGELOG

Migrating from Instiki 0.11-0.19 to 0.20

ruby bundle install --path vendor/bundle
ruby bundle exec rake upgrade_instiki

Download the latest release from:

Visit the Instiki wiki:

Visit the Instiki users forum

License:

  • same as Ruby's

Authors::

Versions 0.0 to 0.9.1:: David Heinemeier Hansson Email:: david[AT]loudthinking.com Weblog:: (http://www.loudthinking.com)[http://www.loudthinking.com]

From 0.9.2 onwards:: Alexey Verkhovsky Email:: alex[AT]verk.info

From 0.11 onwards:: Matthias Tarasiewicz and 5uper.net Email:: parasew[AT]gmail.com Website:: (http://5uper.net)[http://5uper.net]

From 0.13 onwards:: Matthias Tarasiewicz and Jacques Distler Email:: jdistler-instiki[AT]golem.ph.utexas.edu Weblog Jacques: http://golem.ph.utexas.edu/~distler/blog/ Weblog Parasew: http://parasew.com

instiki's People

Contributors

distler avatar jherdman avatar bleything avatar sattlerc avatar jrblevin avatar jzellman avatar mattmacgillivray avatar mileschou avatar oshino-shinobu avatar structuralist avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.