https://github.com/2-3/polkadot

A lightweight personal wiki in Racket
https://github.com/2-3/polkadot

Last synced: 2 months ago
JSON representation

A lightweight personal wiki in Racket

• Host: GitHub
• URL: https://github.com/2-3/polkadot
• Owner: 2-3
• License: mit
• Created: 2015-08-29T23:39:56.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-19T13:00:19.000Z (over 7 years ago)
• Last Synced: 2024-08-04T04:06:51.129Z (6 months ago)
• Language: Racket
• Size: 14.6 KB
• Stars: 18
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-racket - polkadot - A lightweight personal wiki in Racket. (Web Frameworks)
• awesome-racket-and-scheme - polkadot

README

        
# polkadot

A lightweight personal wiki written in Racket. It stands at less than 200 LOC and its only dependency is Rackets "markdown"-package.

## Concept

polkadot displays __documents__ you have written in Markdown and links them to the __tags__ you specified in the document header.

There are no change logs or user accounts or similarly complex features---polkadot is meant as a simple personal wiki.

As such it doesn't aim to replace your whole publishing tool chain, but to be a part of it.

Following this philosophy, documents are simply files.

This makes it very easy to handle them in any way you want--edit them with your favorite editor, over SSH, FTP, or git.

Since documents are cached, there's no huge I/O overhead. polkadot also automagically updates its index on filesystem changes.

## Setup

Since it's a simple piece of software, polkadot is easy to install;

1. First you need to install the package "markdown" with raco: `raco pkg install markdown`

2. Now you should take a look at `polkadot.rkt` and change the configuration variables to your liking.

3. There's no further setup required, just write your documents and run the thing.

## Usage

At start polkadot will index all files in `documents/`.

It will continue to monitor this directory for any updated, added, or deleted files that end with `.polka`.

Static files can be added to `static/`.

You can find an introduction to writing documents in `introduction.polka`.

## Support

You'll find what you're looking for at either [Github](https://github.com/2-3/polkadot/) or, if IRC is your thing in \#polkadot on irc.freenode.net.