You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Arthur POULET b095fe3f31
version: Update version to 0.2.0
4 months ago
config update: Fix depreciated cookie 4 months ago
public Improve update button 4 years ago
spec Add a new markdown spec for empty internal link 4 years ago
src login: Fix bcrypt authentication 4 months ago
.gitignore Move to Amber 4 years ago
.travis.yml Initialize project 4 years ago
LICENSE Initialize project 4 years ago
Makefile update: Fix compatibility with crystal v1.0.0 and lastest deps 4 months ago
README.md update: Fix compatibility with crystal v1.0.0 and lastest deps 4 months ago
docker-compose.yml Move back from amber to kemal 4 years ago
shard.lock update: Fix compatibility with crystal v1.0.0 and lastest deps 4 months ago
shard.yml version: Update version to 0.2.0 4 months ago

README.md

Migrated to https://git.sceptique.eu/Sceptique/wikicr

wikicr

Wiki in crystal and markdown

The pages of the wiki are written in markdown and committed on the git repository where it is started.

How to install

Dependencies

Verify that you have crystal v1.0.0 or greater installed, as well as shards and git.

Get the application

git clone https://github.com/Nephos/wikicr.git
cd wikicr

Test the application

make test

Build the binary

make

Run the server

./wikicr --port 3000

Verify your files

A directory meta/ should be created into wikicr. It must contains several files and directories (acl, index, users, ...). You may want to save this directory because it contains meta-data about the pages.

Another data/ should be a git repository (initialized at the first start). Those files are the ALL the "displayed data" of the wiki.

Security and ACLs

  • Admin panel to manage the directories and pages
  • Rules on directories are terminated with a *
  • If several rules conflict, take the more specific one
    • Directories with the longer name prevails
    • Files rules prevails over directory rules

Administration and usage tutorial

Edit / Create a page

Show a page

Remove a page

Simply edit the page to remove and delete all the content. The page will be deleted completely.

Administrate users and acls

Custom Markdown

A special markdown (wikimd) is used in the pages. It provides several interesting features:

An internal link will search through the index of pages to find a matching one and render a valid link to it.

blabla [[my page]] blabla
Notes about the wikimd
  • internal link algorithm have been benchmarked a bit benchmark link The algorithm has been improved since, but it gave me a first idea of what to do.

Development and Roadmap

You want to add or modify something ?

Don't hesitate to open an issue, I'm always happy to discuss about my projects or include other developers than me.

Contributing

  1. Open an issue to see what you want to implement and how to do it.
  2. Fork it ( https://github.com/Nephos/wikicr/fork )
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request

Operations

For now, there is no "important" core operation to add (they are all already implemented). However, there are still lots of improvements to write on the current implementation, documentation, security check, error management and consistency of the code.

Git

At the beginning, I tried to used libgit2. However, it seems to be a bad idea because the lib was not documented (no tutorial or at least not up-to-date, API not very well documented, etc.) so I want to write a little git-* wrapper to handle some operations (add, commit, revert, etc.).

It is not something very likely to be done first (even if it's a lot of important features) because it is boring and requires to take care of the security issues. I must have to replace the "system" calls (in backquote) with Proccess.new.run.

Web

There is some important features in order to have a good interface and a fluent wiki experience. That's not the stuff I prefer because it requires some css/js (front-end stuff).

There is also work around string matching to write a valid research engine. This is the most important feature to add right now.

Advanced usage

The current implementation of Markdown in crystal is limited and may be fully rewritten with more standard features in some weeks or months. For now, I choose to use Markd, another markdown parser, and wrote a wikimd wrapper (Wikicr::Page::Markdown). It allows me to expand the default markdown by writting HTML inside the markdown to render.

The rest is boring stuff (code factorization, make everything configurable, document the code, add a lot of specs, ...).

Other

Contributors

  • Sceptique Arthur Poulet - creator, maintainer