https://github.com/othelarian/korrig

https://github.com/othelarian/korrig

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/othelarian/korrig
• Owner: othelarian
• License: mit
• Created: 2023-07-23T16:20:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-05T20:34:46.000Z (about 1 year ago)
• Last Synced: 2023-10-05T21:32:57.606Z (about 1 year ago)
• Language: LiveScript
• Size: 54.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The Korrig project

## What's Korrig?

Korrig is a [quine](https://en.wikipedia.org/wiki/Quine_(computing)) webapp, similar in is concept to [TiddlyWiki](https://tiddlywiki.com/) and [FeatherWiki](https://feather.wiki/).

Why another quine wiki? Because I can! Also because TiddlyWiki is now quite heavy, with a lot of stuff already integrated in it, making plugin development hard when touching at too much of it. FeatherWiki on the other hand would be a good choice but lack a true plugin system, meaning you have to fork it for any large modification.

The purpose of Korrig is to propose a really lightweight webapp (hopefully less than 100kB) with 3 main features:

- an article storage (like any wiki)

- a tag system

- a plugin system

## How to get Korrig?

You want to use Korrig? You can download it [here](https://othelarian.github.io/korrig).

## Usage

You downloaded the file, now what to do next?

You can now use the button '+' to create a new article.

TODO

When you want to save your work a button with a download icon in red on top of the page is here to let you download the new version of Korrig, with your modification.

### TiddlySpot

TODO

### KorrigDesktop

TODO

## It doesn't work!

If you meet any issue with Korrig you can [fill an issue](https://github.com/othelarian/korrig/issues). I will try to do my best to answer you. I may need so info though, so don't hesitate to give the maximum of details about your problem.

## Develop mode

TODO

## Credits

Icons from: [lucide.dev](https://lucide.dev)