ref: 0.0.1
./README.md
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
# hidrocor A simple, tiny, markdown-based wiki engine. Useful for creating simple wikis, with minimal effort on deployment, configuration and management. ## Preamble hidrocor should be installed via your system package manager. You can, however, compile from source by grabbing a tarball. If installed from the source, you just need to run: ```sh $ make # make install ``` ## Configurating wikis A wiki, is just a folder containing some markdown files. hidrocor will parse and turn them into simple pages, and link any `/*.md` contained inside the same folder. You can mantain these wikis as a git repository for collaboration. hidrocor will also parse any YAML meta tag and lookup for a `title` to display as the title of page and wiki. You'll need to supply the path of the wiki via the flag `--wiki`, and override the system service via `/etc/conf.d/hidrocor`. ## Contributing The upstream repository can be found [here][repo]. Send patches to [porcellis@eletrotupi.com][mailing-list] or open pull requests [on the GitHub mirror][github]. ## License GNU GPL-3.0 [repo]: https://git.eletrotupi.com/hidrocor [mailing-list]: mailto:porcellis@eletrotupi.com [github]: https://github.com/pedrolucasp/hidrocor |