Metadata-Version: 2.1
Name: reveal-yaml
Version: 1.1.0
Summary: A YAML, Markdown, reveal.js based Flask application. Supports gh-pages deployment actions.
Home-page: https://kmolyuan.github.io/reveal-yaml
Author: Yuan Chang
Author-email: pyslvs@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: pyyaml
Requires-Dist: flask
Requires-Dist: werkzeug
Requires-Dist: frozen-flask

# Reveal.yaml

[![PyPI](https://img.shields.io/pypi/v/reveal-yaml.svg)](https://pypi.org/project/reveal-yaml/)

See the [documentation](https://kmolyuan.github.io/reveal-yaml/).

This project is under MIT license.

Quickly create a Reveal.js writing environment!

```bash
mkdir myproject
cd myproject
rym init .
rym serve --port=5000
```

Then start writing the slides in Markdown.

## JSON Schema

+ [schema.json](https://raw.githubusercontent.com/KmolYuan/reveal-yaml/gh-pages/schema.json)
+ [schema.yaml](https://raw.githubusercontent.com/KmolYuan/reveal-yaml/master/reveal_yaml/schema.yaml)

## Deployment

Build to a static HTML format: (`index.html` and `static` folder)

```bash
rym pack build/
```

A Github workflow `.github/workflows/deploy.yml` generated by `rym init`
can also be used on your repository.


