Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tlatsas/wigiki
Static html wiki generator using Github's Gists™ as pages
https://github.com/tlatsas/wigiki
Last synced: 3 months ago
JSON representation
Static html wiki generator using Github's Gists™ as pages
- Host: GitHub
- URL: https://github.com/tlatsas/wigiki
- Owner: tlatsas
- License: mit
- Archived: true
- Created: 2013-06-01T09:28:57.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T08:01:48.000Z (11 months ago)
- Last Synced: 2024-09-20T08:47:51.286Z (4 months ago)
- Language: Python
- Homepage: http://tlatsas.github.io/wigiki/
- Size: 132 KB
- Stars: 10
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wigiki
[](https://travis-ci.org/tlatsas/wigiki)
## about
Wigiki is a python application which can render static html wiki-like
sites using Github's Gists as pages. I use Gists to keep quick notes, but
the important ones can get quickly lost due to the high signal to noise
ratio. With wigiki I can group the important ones in a single place which
I can deploy anywhere as it is just html+css files. Here is how it
[looks][site-sample] using the default template theme.
## installation
To install from pypi:
```
$ pip install wigiki
```
To install from source, clone the repo and then run:
```
$ python setup.py install
```
If you want to install wigiki in order to contribute code, clone
the repo and then run:
```
$ pip install -e .
```
It is also a good idea to use a virtual environment (virtualenv/virtualenvwrapper).
## getting started
Using wigiki is as simple as creating a configuration file (see [sample][cfg-sample])
and running `wigiki`.
For a list of command line arguments use `--help` or consult the documentation.
* [documentation][gh-docs]
* [issues][gh-issues]
* [source code][gh-source]
* [pypi][pypi]
## license
See `LICENSE`.
[gh-docs]: http://tlatsas.github.io/wigiki/
[gh-issues]: https://github.com/tlatsas/wigiki/issues
[gh-source]: https://github.com/tlatsas/wigiki
[cfg-sample]: https://github.com/tlatsas/wigiki/blob/master/config.json.sample
[site-sample]: https://dl.kodama.gr/notes
[pypi]: https://pypi.python.org/pypi/wigiki