diff options
| author | Yehonal <yehonal.azeroth@gmail.com> | 2017-05-27 01:24:12 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-05-27 01:24:12 +0200 |
| commit | 98fff4f0d1ab767d68d9a90dfcbcc4eb8cf6a304 (patch) | |
| tree | 0aaf797e89330d14e8fd1134a661da4335323c9f /README.md | |
| parent | cdbba65c38001d85c9fbbb8bc8059fe8907b6480 (diff) | |
| download | wiki-98fff4f0d1ab767d68d9a90dfcbcc4eb8cf6a304.tar.gz wiki-98fff4f0d1ab767d68d9a90dfcbcc4eb8cf6a304.tar.bz2 wiki-98fff4f0d1ab767d68d9a90dfcbcc4eb8cf6a304.zip | |
Create README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..a7c14c3 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +# Welcome to git-wiki demo + +This is a [demo](wiki/Demo.md) of git-wiki theme for jekyll. + +it's a full featured wiki powered by git, github pages and pull-requests! + +It means: + +* Improvements in the cooperative aspect: forks, pull-requests and roles. +* You can customize your wiki as you want with style sheets and even changing the layout. +* No databases! Only static files that can be downloaded in a few seconds. +* Markdown and html mixed together! +* History, revision comparison and everything you need from a wiki platform. +* You can edit your pages with the standard git editor, prose.io (integrated) or any kind of editor you prefer. + +You can fork/copy the master branch now and start your wiki in just 1 minute. + +Then [share your wiki with us!](wiki/Showreel.md) please. + +**Note:** +You can even include the github wiki as a submodule and enable the conf, but it's an experimental feature and it implies less advantages and greater disadvantages for now. + +## Installation instructions + +1. Fork or copy [this repository](https://github.com/drassil/git-wiki) + +2. copy and rename _config.yml.dist in _config.yml changing settings inside + +3. create your index.md in root directory + +4. push your changes in your repository, then configure the github pages in your repository settings + +5. Your wiki is ready! + +**Note:** + +We suggest the creation of a /wiki/ subfolder that collects all your .md pages (except index.md) + +## Current known limitations + +* Non-existent wiki page links are not "[red](wiki/red.md)". + +* You can't use the wiki link format: [[example]]. Please, use gh-pages links instead: \[example\](example) + +## Customization + +You can create following files in _includes folder to costumize git-wiki without patching original code: + +* head.html -> this file will be included in <head> tag allowing you to add css/js and any kind of head tags +* sidebar.html -> this file will be included in left sidebar allowing you to create your widgets +* comments.html -> this is mostly used to integrate social comments under page contents +* footer.html -> this file will be included in left side of the footer. + +## Looking for collaboration + +Do you like this project? then, contact us via [chat](https://gitter.im/Drassil/general?utm_source=share-link&utm_medium=link&utm_campaign=share-link) , <a href="mailto:staff-drassil@googlegroups.com">email</a> or send us a PR to improve it. + +Thank you! + +## Components used + +- [jekyll-table-of-contents](https://github.com/ghiculescu/jekyll-table-of-contents) + +- [jQuery](https://jquery.com/) + + +[MIT LICENSE](LICENSE) |