| Name | slides-xp JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2025-02-23 09:05:24 |
| maintainer | None |
| docs_url | None |
| author | Maddy Guthridge |
| requires_python | >=3.11 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Slides XP
A simple but flexible markdown slide-show viewer.
## Running
```sh
sxp <directories to serve>
```
## Theming
You can use the `--theme` option to specify the a built-in theme, or a path to
a directory containing CSS theme files.
The built-in themes are:
* `default`
* `xp`
### Python-generated slides
Python files that end with `.slide.py` can be used to generate slides using
Python, which is useful for custom themed slides. The file should include a
`render` function that returns a `pyhtml` tag.
### Custom CSS
A theme directory should contain (at least) these files:
* `main.css`: main stylesheet. Always loaded.
* `slide.css`: stylesheet for slide pages.
* `picker.css`: stylesheet for slide picker page.
These stylesheets are mounted at the `/theme` endpoint.
Within these stylesheets, the following classes can be selected.
* `.highlight`: code blocks
* `.slide-content`: slide content
* `.picker-box`: slide picker
* `.picker-item`: slide within slide picker
And the following variables are available:
* `--hl-comment`: code block highlighting, comment
* `--hl-doc`: code block highlighting, documentation
* `--hl-keyword`: code block highlighting, keyword
* `--hl-var`: code block highlighting, variable
* `--hl-func`: code block highlighting, function
* `--hl-type`: code block highlighting, type
* `--hl-string`: code block highlighting, string
Raw data
{
"_id": null,
"home_page": null,
"name": "slides-xp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Maddy Guthridge",
"author_email": "hello@maddyguthridge.com",
"download_url": "https://files.pythonhosted.org/packages/93/c5/1262a5a83bf9fb9d379cd28f5424b7915b028aa990664ed96df8b46e571e/slides_xp-0.0.5.tar.gz",
"platform": null,
"description": "# Slides XP\n\nA simple but flexible markdown slide-show viewer.\n\n## Running\n\n```sh\nsxp <directories to serve>\n```\n\n## Theming\n\nYou can use the `--theme` option to specify the a built-in theme, or a path to\na directory containing CSS theme files.\n\nThe built-in themes are:\n\n* `default`\n* `xp`\n\n### Python-generated slides\n\nPython files that end with `.slide.py` can be used to generate slides using\nPython, which is useful for custom themed slides. The file should include a\n`render` function that returns a `pyhtml` tag.\n\n### Custom CSS\n\nA theme directory should contain (at least) these files:\n\n* `main.css`: main stylesheet. Always loaded.\n* `slide.css`: stylesheet for slide pages.\n* `picker.css`: stylesheet for slide picker page.\n\nThese stylesheets are mounted at the `/theme` endpoint.\n\nWithin these stylesheets, the following classes can be selected.\n\n* `.highlight`: code blocks\n* `.slide-content`: slide content\n* `.picker-box`: slide picker\n* `.picker-item`: slide within slide picker\n\nAnd the following variables are available:\n\n* `--hl-comment`: code block highlighting, comment\n* `--hl-doc`: code block highlighting, documentation\n* `--hl-keyword`: code block highlighting, keyword\n* `--hl-var`: code block highlighting, variable\n* `--hl-func`: code block highlighting, function\n* `--hl-type`: code block highlighting, type\n* `--hl-string`: code block highlighting, string\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.0.5",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ceec07d114babd5872b41ef1f24d2a5159b3592b4f57fe9c7920a5a3f9b5f0e9",
"md5": "4916427c4cdf580678bb74ce6b31e4d5",
"sha256": "3aaff4b96bf48d347280aaca116a0d4b7f91a81ee6c9e7608b2e3f1f989c37c9"
},
"downloads": -1,
"filename": "slides_xp-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4916427c4cdf580678bb74ce6b31e4d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 2083077,
"upload_time": "2025-02-23T09:05:22",
"upload_time_iso_8601": "2025-02-23T09:05:22.619771Z",
"url": "https://files.pythonhosted.org/packages/ce/ec/07d114babd5872b41ef1f24d2a5159b3592b4f57fe9c7920a5a3f9b5f0e9/slides_xp-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "93c51262a5a83bf9fb9d379cd28f5424b7915b028aa990664ed96df8b46e571e",
"md5": "44cc683af24014e209137b93cc2b0fce",
"sha256": "5e49b99acf58cdb40df73a63b8ca9011190bb64d6bb197e5d44488be55bb7866"
},
"downloads": -1,
"filename": "slides_xp-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "44cc683af24014e209137b93cc2b0fce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 2066729,
"upload_time": "2025-02-23T09:05:24",
"upload_time_iso_8601": "2025-02-23T09:05:24.784540Z",
"url": "https://files.pythonhosted.org/packages/93/c5/1262a5a83bf9fb9d379cd28f5424b7915b028aa990664ed96df8b46e571e/slides_xp-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-23 09:05:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "slides-xp"
}
