Skip to main content

Make github presentations like a boss

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rikiri-0.6.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

rikiri-0.6-py2-none-any.whl (1.6 MB view details)

Uploaded Python 2

File details

Details for the file rikiri-0.6.tar.gz.

File metadata

  • Download URL: rikiri-0.6.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for rikiri-0.6.tar.gz
Algorithm Hash digest
SHA256 a888021bb20fffdcba70cf110cc19142b7826b01375f01fad82e36174d52d3a6
MD5 616d459dbdca6ac553b720d0255adeb0
BLAKE2b-256 05c0288cccb26c376ed781eacc46fc8face189053470d9f2546edf720431cd19

See more details on using hashes here.

File details

Details for the file rikiri-0.6-py2-none-any.whl.

File metadata

File hashes

Hashes for rikiri-0.6-py2-none-any.whl
Algorithm Hash digest
SHA256 63fab57d2d2c9f3bb510812a3a7dec93c3d032235457199e181bfdbb4add0d1b
MD5 0fe90f246e393c4ed5cb424b68f95e60
BLAKE2b-256 a1b497e4bed88ba173c92961df745deea9fb4d48b823736faa584dde8992a13e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page