Metadata-Version: 2.4
Name: sphinx-revealjs-quickstart
Version: 0.0.2
Summary: Quickstart CLI to scaffold Sphinx + sphinx-revealjs presentation projects
Author-email: nikkie <takuyafjp+develop@gmail.com>
License: MIT License
Project-URL: Repository, https://github.com/ftnext/sphinx-revealjs-quickstart
Project-URL: Issues, https://github.com/ftnext/sphinx-revealjs-quickstart/issues
Keywords: sphinx,sphinx-revealjs,revealjs,presentation,quickstart
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Framework :: Sphinx
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Multimedia :: Graphics :: Presentation
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Sphinx
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-randomly; extra == "dev"
Dynamic: license-file

# sphinx-revealjs-quickstart

A CLI to quickly scaffold presentation projects with Sphinx + sphinx-revealjs.

## Usage

```console
uvx sphinx-revealjs-quickstart -p project -a author
```

## Generated Files

```text
.
├── .github/
│   └── workflows/
│       └── publish-pages.yml
├── Makefile
├── build/
└── source/
    ├── _static/
    │   └── css/
    │       └── common.css
    ├── _templates/
    │   └── page.html
    ├── conf.py
    └── index.rst
```

## About the Generated Content

- `source/conf.py` and `source/_static/css/common.css` contain settings and styles that creator (nikkie) usually uses
- TODO: Make this customizable per project
