Skip to main content
<div align="center">
<img src="https://raw.githubusercontent.com/MaciejCzyzewski/hyhyhy/master/screenshot.png"/>
</div>

# hyhyhy [![Build Status](https://travis-ci.org/MaciejCzyzewski/hyhyhy.png)](https://travis-ci.org/MaciejCzyzewski/hyhyhy) [![PyPI version](https://badge.fury.io/py/hyhyhy.png)](http://badge.fury.io/py/hyhyhy)

Presentation nano-framework.

## Installation

Binary installers for the latest released version are available at the [Python
package index.](http://pypi.python.org/pypi/hyhyhy/)

```
$ pip install hyhyhy
```

You can create a new project by generating structure like this. Make sure that the destination folder does not exist because it will be overwritten.

```
|-- assets
| |-- index.jinja
| |-- scripts
| | |-- main.js
| |-- styles
| | |-- main.css
|-- sections
| |-- 1.html
| |-- 2.md
| |-- ...
| |-- n.html
|-- default.cfg
```

## Usage

### Build

This function should splice all your slides/sections in one presentation.
When you build your project it will generate a static version in the build folder that you can use.

```
$ hyhyhy build
```

### Create

Creates a default structure.

```
$ hyhyhy create
```

### Status

Show the structure of your project.

```
$ hyhyhy status
```

### Help

Displays a brief summary of the basic functions.

```
$ hyhyhy help
```

## Configuration

For now, you can change the basic variables in the configuration file.

```
[head]
title = Example presentation by hyhyhy!
description = A little words...

[core]
build = build/index.html
```

You can also manipulate additional settings for 'section' tag in html.

```
[sections]
5 = data-bespoke-state="green" class="light"
```

The output for the above should be the following code. (for 5 slide)

```
<section data-bespoke-state="green" class="light">...</section>
```

## Presentation

- Press `left arrow` and `right arrow` to navigate.
- Press `h` to launch fullscreen.
- Press `ESC` to exit fullscreen mode.
- Browser zooming is supported.
- Touch events are supported.

## Dependencies

- Python (>= 2.7.0)
* rjsmin
* rcssmin
* markdown
* jinja2
- Javascript
* prism.js
* bespoke.js

## Quickstart

```
$ pip install hyhyhy
$ mkdir new_empty_presentation
$ cd new_empty_presentation
$ hyhyhy create
$ hyhyhy build
```

## Example

Sample presentation is already in the project. But if you want you can see it live [by clicking this link.]()

## Contributing

Please feel free to contribute to this project! Pull requests and feature requests welcome! :v:

## License

See LICENSE file in this repository.

Metadata

Release files for hyhyhy 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hyhyhy 1.0.1
File Size Uploaded Provenance Actions
hyhyhy-1.0.1.tar.gz 4.5 kB Without provenance Details for hyhyhy-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for hyhyhy 1.0.1
File Interpreter ABI Platform Actions
hyhyhy-1.0.1.macosx-10.9-intel.exe Details for hyhyhy-1.0.1.macosx-10.9-intel.exe

Total release size: 78.4 kB

Release files / hyhyhy-1.0.1.tar.gz

Download URL hyhyhy-1.0.1.tar.gz
Size 4.5 kB
Tags Source
SHA-256 checksum
How to use checksums
dd9936ab000b075feb5e7a19308b6842422352017fc6c6019e7c1a770474cbb6
BLAKE2b-256 checksum
How to use checksums
566cfd198a83932399ffd0e232fa10c9cc772fe282769272e6c5107358ef75b8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / hyhyhy-1.0.1.macosx-10.9-intel.exe

Download URL hyhyhy-1.0.1.macosx-10.9-intel.exe
Size 73.8 kB
Tags Source
SHA-256 checksum
How to use checksums
24fb5c34bc8c733360e992a8d6f59c7827eb428928ffa9126b59227033278a6c
BLAKE2b-256 checksum
How to use checksums
1f86ef4a11fbce53bac8224a9547c3e0d6978aa7bd212fb05b0e9e8120de07fa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for hyhyhy 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page