| Name | slidec JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A Terminal-based Markdown Slide Presenter. |
| upload_time | 2024-12-23 14:22:59 |
| maintainer | None |
| docs_url | None |
| author | Phil Whybra |
| requires_python | >=3.11 |
| license | MIT |
| keywords |
terminal
slides
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# slidec
A simple python tool to present markdown in your terminal as slides.
Useful if you are wanting to do demos from the command line and refer to notes.
Works well with tmux (etc.) split planes, one for live demo, one for the
slides/notes.
Option to fuzzy search and jump to selected slide if
[`fzf`](https://github.com/junegunn/fzf) is installed.
<img src="assets/demo.gif">
## Slide Format
Slides are written in a single markdown file separated by `---`.
E.g.
```markdown
# Example slide 1
- Content
---
# Example slide 2
- More content
```
> [!NOTE]
> There should be no trailing white space after `---`.
## Run
```terminal
slidec example_slides.md
```
## Install
### Dev
In chosen python environment, from repo root directory, run
```terminal
pip install -e .
```
## Navigation
Once in presentation mode
- Next slide: `n` or `j`
- Previous slide: `p` or `k`
- Select slide: `g` navigate with fuzzy search (requires [`fzf`](https://github.com/junegunn/fzf))
- quit: `q`
## Inspiration
There are other much more robust tools for this task, such as
[`lookatme`](https://github.com/d0c-s4vage/lookatme) or
[`slides`](https://github.com/maaslalani/slides).
However, I found I could get all the functionality I needed in a single small python
script.
As an exercise, I have since turned the `slidec.py` script it into a python package for
easy install, though it still works on it's own.
Raw data
{
"_id": null,
"home_page": null,
"name": "slidec",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "terminal slides",
"author": "Phil Whybra",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b1/d7/707d71167447af2585b3c759ba90c2cb1ccdf71d2714e3ccf0c70f74d37e/slidec-0.1.0.tar.gz",
"platform": null,
"description": "# slidec\n\nA simple python tool to present markdown in your terminal as slides.\n\nUseful if you are wanting to do demos from the command line and refer to notes.\n\nWorks well with tmux (etc.) split planes, one for live demo, one for the\nslides/notes.\n\nOption to fuzzy search and jump to selected slide if\n[`fzf`](https://github.com/junegunn/fzf) is installed.\n\n\n<img src=\"assets/demo.gif\">\n\n## Slide Format\n\nSlides are written in a single markdown file separated by `---`.\n\nE.g.\n\n```markdown\n# Example slide 1\n\n- Content\n\n---\n\n# Example slide 2\n\n- More content\n\n```\n\n> [!NOTE]\n> There should be no trailing white space after `---`.\n\n\n## Run\n```terminal\nslidec example_slides.md\n```\n\n## Install\n\n### Dev\nIn chosen python environment, from repo root directory, run\n```terminal\npip install -e .\n```\n\n## Navigation\nOnce in presentation mode\n\n- Next slide: `n` or `j`\n- Previous slide: `p` or `k`\n- Select slide: `g` navigate with fuzzy search (requires [`fzf`](https://github.com/junegunn/fzf))\n- quit: `q`\n\n## Inspiration\n\nThere are other much more robust tools for this task, such as\n[`lookatme`](https://github.com/d0c-s4vage/lookatme) or\n[`slides`](https://github.com/maaslalani/slides).\n\nHowever, I found I could get all the functionality I needed in a single small python\nscript.\n\nAs an exercise, I have since turned the `slidec.py` script it into a python package for\neasy install, though it still works on it's own.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Terminal-based Markdown Slide Presenter.",
"version": "0.1.0",
"project_urls": {
"Source": "https://github.com/pwhybra/slidec"
},
"split_keywords": [
"terminal",
"slides"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c8f1190836aa378c1d0abc02af0d42ba93f74e1424e3469da1c0c349deaac183",
"md5": "2718453619bf4a2e250ecff646ee3517",
"sha256": "fe3948802c90f5cbad890af9f07e5fb73b4b2e9f162e5b5b88ef10aca6fa0da6"
},
"downloads": -1,
"filename": "slidec-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2718453619bf4a2e250ecff646ee3517",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 4594,
"upload_time": "2024-12-23T14:22:57",
"upload_time_iso_8601": "2024-12-23T14:22:57.072741Z",
"url": "https://files.pythonhosted.org/packages/c8/f1/190836aa378c1d0abc02af0d42ba93f74e1424e3469da1c0c349deaac183/slidec-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b1d7707d71167447af2585b3c759ba90c2cb1ccdf71d2714e3ccf0c70f74d37e",
"md5": "6ea0d27161103f0d3361923e8cba9445",
"sha256": "60c33e03615e3afcfb4a42d3000b5b859ae8ec9c72c43f146b9508654777d714"
},
"downloads": -1,
"filename": "slidec-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "6ea0d27161103f0d3361923e8cba9445",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 4302,
"upload_time": "2024-12-23T14:22:59",
"upload_time_iso_8601": "2024-12-23T14:22:59.575561Z",
"url": "https://files.pythonhosted.org/packages/b1/d7/707d71167447af2585b3c759ba90c2cb1ccdf71d2714e3ccf0c70f74d37e/slidec-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-23 14:22:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pwhybra",
"github_project": "slidec",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "slidec"
}
