https://github.com/jswrenn/stiki
Static Wiki
https://github.com/jswrenn/stiki
Last synced: 3 months ago
JSON representation
Static Wiki
- Host: GitHub
- URL: https://github.com/jswrenn/stiki
- Owner: jswrenn
- License: mit
- Created: 2015-09-15T00:34:16.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-09-20T19:25:20.000Z (over 9 years ago)
- Last Synced: 2025-03-14T18:59:21.067Z (3 months ago)
- Language: Racket
- Size: 141 KB
- Stars: 2
- Watchers: 6
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stiki - The Static Wiki
The premise:
- Files are articles
- Folders are categories
## Installation
Besides racket, Stiki has three dependencies.
### find
To speed rendering up, Stiki uses the unix utility `find` rather than Racket's filesystem procedures.
### Sugar
```sh
raco pkg install sugar
```
### Markdown
```sh
raco pkg install markdown
```
If you want to allow links with spaces in them, use a fork of Markdown
```sh
raco pkg install https://github.com/jswrenn/markdown.git
```
## Usage
```sh
racket -l stiki/main [SOURCE-DIRECTORY] [DEST-DIRECTORY] [EDIT-URL-FRAGMENT] [HISTORY-URL-FRAGMENT]
```
The EDIT-URL-FRAGMENT and HISTORY-URL-FRAGMENTS are the partial links for your wiki's online git hosting's edit and history pages for a file.
Github's integrated editor for this readme is `https://github.com/jswrenn/markdown/blob/master/README.md`.
The fragment you would pass to Stiki would be `https://github.com/jswrenn/markdown/edit/master/`
## Customization
Just modify the source code to your liking. There's about 100 important lines of Racket, with another 100 lines of useful path utilities for making writing templates easier.