igolyudov / gitiki

GIT and wIKI

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GITIKI = GIT + WIKI

Gitiki - простой способ организации WIKI с использованием только git и markdown файлов.

Возможности

Для markdown файлов поддерживается commonmark спецификация. Поддерживаются ссылки между страницами и вложенными каталогами.

Применение

В application.properties только один обязательный параметр:

  • gitiki.root - указывает на каталог с git репозиторием (это может быть как каталог в который клонирован репозиторий, так и 'голый' репозиторий).

Опциональный параметрый:

  • server.port - порт встроенного web-сервера (по умолчанию: 8910);
  • gitiki.template - название шаблона (по умолчанию: bootstrap).

Особенности

  • Точка входа - index.md файл.
  • При создании ссылок расширение файлов (.md) опускается.
  • Для доступа к конкретной версии файла используется параметры version (README?version=420eac9) в котором передается git commit hash целиком или его сокращенная версия (short).

About

GIT and wIKI

License:Apache License 2.0


Languages

Language:Java 78.1%Language:HTML 12.6%Language:CSS 6.8%Language:Dockerfile 2.6%