Skip to content

igolyudov/gitiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GITIKI = GIT + WIKI

Gitiki - a simple way to organize a WIKI using only git and markdown files.

Functionality

  • With full git versioning support.
  • Only markdown files in git repository.
  • Without any database.
  • With custom theme support.
  • With bootstrap default theme build-in.
  • For markdown files support commonmark specification.
  • Support cross-page links with subfolders.

Configuration

In application.properties only one required option:

  • gitiki.root - points to the directory with the git repository (this could be a directory of cloned repository or bared repository)

Optional:

  • server.port - port of embedded web-server (default: 8910);
  • gitiki.template - template name (default: bootstrap).

Features of use

  • Welcome page (point of entry) - index.md file.
  • When specifying links, the file extension (.md) may be omitted.
  • To access a specific version of a file, use the parameters version (README?version=420eac9) with 'full' or 'short' git commit hash.