skip to navigation
skip to content

rikiri 0.6

Make github presentations like a boss

Copyright (c) 2017 Sathya Narrayanan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Description: ## Rikiri

Rikiri let's you to compose html presentations with markdown files or another static files, although it's scope is currently restricted to markdown for now.

## Installation

```
pip install rikiri

```

## Usage

```
usage: rikiri [-h] [-t TITLE] [-o OUTDIR] [-s SOURCEDIR]

Make github HTML presentation like a boss

optional arguments:
-h, --help show this help message and exit
-t TITLE, --title TITLE
title of the presentation
-o OUTDIR, --outdir OUTDIR
output directory
-s SOURCEDIR, --sourcedir SOURCEDIR
Source directory

```

If you have markdown files stored in a particular directory then you can convert it into html presentation with a help of below command.

```
.
├── source
│ ├── file11.md
│ └── file12.md
└── README.md
```

```
rikiri -t <title_of_presentation> -s <source_dir>

```

## LICENSE

MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Console
 
File Type Py Version Uploaded on Size
rikiri-0.6-py2-none-any.whl (md5) Python Wheel py2 2017-10-13 1MB
rikiri-0.6.tar.gz (md5) Source 2017-10-13 1MB