Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

miniwiki

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

miniwiki

  • 0.0.1
  • Rubygems
  • Socket score

Version published
Maintainers
1
Created
Source

MiniWiki

MiniWiki is a minimal Markdown-based Wiki. You give it a directory full of .md files and it renders them for you with links to every page.

Here is what you get:

Screenshot

Installation

    gem install rerun  # <- For auto-reloading.
    gem install miniwiki

Usage

    miniwiki /path/to/markdown/directory 4321

Then point your favorite browser to http://localhost:4321.

From that point on MiniWiki will tell you more itself.

If you do not expect your Markdown files to change (on a server, for instance), you can also run

    miniwiki-server /path/to/markdown/directory 4321

This will skip the auto-reloading and keep MiniWiki running.

Good To Know

  • Use the file extension .md, not .markdown.
  • Static files in the Markdown directory (.png, .gif, .pdf, ...) will be served properly. Images are not automatically resized, though (you can use your browser for that).
  • MiniWiki consists of one single small Sinatra file. So its feature set is scarce by design. There are no view files etc.; everything is neatly crammed into the lib/miniwiki/app.rb file and kept to a minimum.

FAQs

Package last updated on 29 May 2014

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc