https://github.com/axodotdev/slippy
🖼 markdown slideshows in rust
https://github.com/axodotdev/slippy
Last synced: 10 months ago
JSON representation
🖼 markdown slideshows in rust
- Host: GitHub
- URL: https://github.com/axodotdev/slippy
- Owner: axodotdev
- License: apache-2.0
- Created: 2023-03-11T15:54:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-18T16:11:21.000Z (almost 3 years ago)
- Last Synced: 2024-10-05T14:05:51.038Z (almost 2 years ago)
- Language: CSS
- Homepage:
- Size: 178 KB
- Stars: 14
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
> 🖼 the easiest way to make slideshows
## Usage
```sh
Usage: slippy [OPTIONS]
Arguments:
Options:
-t, --theme [possible values: light, dark, cupcake]
-h, --help Print help
-V, --version Print version
```
### Basic usage
```sh
> slippy deck.md
```
### Changing the theme
```sh
> slippy --theme=dark deck.md
```
Current themes are:
- light (default)
- dark
- cupcake
- axo
- nash
### Adding custom css
By placing a `deck.css` in the root axo-slides will automatically recognize it and place it at the contents at the end of the CSS
### Using local assets
Any images or assets that you want to be on your published slideshow must be in the `static` folder, this folder will be copied over to the public directory, ready to be uploaded to any static file hoster.
## License
Licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or [apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0))
- MIT license ([LICENSE-MIT](LICENSE-MIT) or [opensource.org/licenses/MIT](https://opensource.org/licenses/MIT))
at your option.