{"id":16589401,"url":"https://github.com/oknozor/unveil-rs","last_synced_at":"2025-11-01T02:30:28.053Z","repository":{"id":54835982,"uuid":"246649095","full_name":"oknozor/unveil-rs","owner":"oknozor","description":"Unveil Rs is a tool to create presentations from markdown inspired by reveal.js, mdbook and zola.","archived":false,"fork":false,"pushed_at":"2024-08-16T13:03:54.000Z","size":1296,"stargazers_count":48,"open_issues_count":14,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-12T23:08:38.575Z","etag":null,"topics":["markdown","presentation-slides","reveal","reveal-js","rust"],"latest_commit_sha":null,"homepage":"https://oknozor.github.io/unveil-rs/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oknozor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.MD","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-11T18:24:54.000Z","updated_at":"2024-09-10T15:03:01.000Z","dependencies_parsed_at":"2024-10-25T18:29:42.025Z","dependency_job_id":"1f31c9d6-ba53-402b-9637-dd18142850f8","html_url":"https://github.com/oknozor/unveil-rs","commit_stats":{"total_commits":57,"total_committers":5,"mean_commits":11.4,"dds":0.07017543859649122,"last_synced_commit":"adc0f7bb52013067f0f9d0bee4a1959bbb1fb3f1"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oknozor%2Funveil-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oknozor%2Funveil-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oknozor%2Funveil-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oknozor%2Funveil-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oknozor","download_url":"https://codeload.github.com/oknozor/unveil-rs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239248400,"owners_count":19607012,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","presentation-slides","reveal","reveal-js","rust"],"created_at":"2024-10-11T23:08:40.775Z","updated_at":"2025-11-01T02:30:28.021Z","avatar_url":"https://github.com/oknozor.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"#  Unveil Rs [![Latest Version]][crates.io] [![Build Status]][travis]\n\n[Build Status]: https://travis-ci.com/oknozor/unveil-rs.svg?branch=master\n[travis]: https://travis-ci.com/oknozor/unveil-rs\n[Latest Version]: https://img.shields.io/crates/v/unveil-rs.svg\n[crates.io]: https://www.crates.io/crates/unveil-rs\n\nUnveil Rs is a tool to create presentations from markdown files.\nIt is inspired by [reveal.js](https://github.com/hakimel/reveal.js) \n, [mdbook](https://github.com/rust-lang/mdBook) and [zola](https://www.getzola.org/).\n\n## What does it look like ?\n\nSee the [live demo](https://oknozor.github.io/unveil-rs/).\n\n## Installation\n\n1. From crates.io \n\nAt the moment unveil is only available on [crates.io](https://crates.io). \n\nTo get started you will need to install rust and then type the following command in a terminal :\n\n```shell script\ncargo install unveil-rs --version=0.1.2-alpha1\n```\n\nNote : the `--version` flag is required while unveil version is still in alpha. \n\n2. From git\n\nIf you want the latest you can run :\n```shell script\ncargo install --git https://github.com/oknozor/unveil-rs.git unveil-rs\n``` \n\n## Usage\n\n### Initialize \n\nTo initialize an empty project run :\n\n```shell script\nunveil init mypresentation\n```\n\nThis will create the following directory structure :\n\n```shell script\n├── slides\n│   └── landing.md\n└── unveil.toml\n```\n\n### Build and run\n\nTo build your project run : \n```shell script\ncd mypresentation \u0026\u0026 unveil build\n```\n\nThis command generate the following files : \n```shell script\n├── public\n│   ├── fontawesome\n│   │   ├── css\n│   │   │   └── fontawesome.css\n│   │   └── webfonts\n│   │       ├── (...)\n│   ├── clipboard.js\n│   ├── highlight.css\n│   ├── highlight.js\n│   ├── index.html\n│   ├── livereload.js\n│   ├── unveil.css\n│   └── unveil.js\n│   └── user_css.css\n├── slides\n│   └── landing.md\n└── unveil.toml\n```\n\nActually the build command is optional, you can directly run `unveil serve` inside your\nproject root directory. This will build the static site and start serving it on `localhost:7878`.\n\nFrom this point you can start editing your markdown slides. The site will reload as you edit it. \n\n### Add new slides\n\nTo add a slide run `unveil new myslide` inside your project root directory. it will create a new markdown file \n`myslide.md` in the `slides/` directory and add a slide entry in the `unveil.toml` config file. \n\n```toml\nname = \"mypresentation\"\nlanguage = \"EN\"\ngitignore = true\nslides = [\"landing.md\", \"myslide.md\"]\n```\n\n### Add style to your slides\n\nInspired by [zola's frontmatter](https://www.getzola.org/documentation/content/page/#front-matter) unveil slides can be \nstyled with a style matter block. The Sass style matter is a style attached to the current slide embedded in a file at the beginning of \nthe file enclosed by triple pluses (+++). If your slide does not have additional styling, the opening and closing +++ are optional.\n\nExample : \n```markdown \n+++\nbackground-color: black;\ncolor: white;  \n\nh1 {\n    color: red;\n}\n+++\n# I am red \n\nI am white and my background is black\n```\n\n### Custom CSS properties \n\nUnveil use some custom CSS properties to help you design your slides.\n\nFor example you can add transition on slides using the `--on-enter-animation` CSS property on your slide's stylematter :\n\n```markdown\n+++\n--on-enter-animation: zoom-in\n+++\n# I will zoom in on enter\n```\n\n#### Available custom CSS properties\n\n| name                  |   allowed values                    | status       |  \n| :---                  | :---                                |  :---        |\n|`--on-enter-animation` | `fade-in`, `zoom-in`                | implemented  |\n\nIf you want to see more custom properties and transitions in unveil, please let us know ! \n\n### Hljs\n\nUnveil use hljs to generate pretty code snippet. Rust code can be played thanks to [the rust playground project](https://play.integer32.com/help).\n\n\n### Commands\n\n| name   | description                              |   args                              | \n| :---   | :-----------                             | :---                                |\n|init    | new project                              |  `PROJECT_NAME` default = `unveil`  |\n|build   | build the project                        |                                     |\n|clean   | wipe the public  directory               |                                     |\n|serve   | serve the project, build it if needed    |                                     |\n|add     | create a new slide                       | `SLIDE_NAME` required               |\n\n## Contributions\n\nUnveil is at a very early stage of it's development and any help is welcome. If you want to participate read the \n[contributing guidelines](CONTRIBUTING.MD) and pick an [issue](https://github.com/oknozor/unveil-rs/issues)! \n\n## Getting Help \n\nNeed help ? You can contact us via our [matrix channel](https://riot.im/app/#/room/#unveil-rs:matrix.org) or ask a question\non the [issue tracker](https://github.com/oknozor/unveil-rs/issues).\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foknozor%2Funveil-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foknozor%2Funveil-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foknozor%2Funveil-rs/lists"}