https://github.com/ryu22e/cookiecutter-sphinx-revealjs

Cookiecutter Template for sphinx-revealjs
https://github.com/ryu22e/cookiecutter-sphinx-revealjs

cookiecutter cookiecutter-template presentation-slides reveal-js revealjs sphinx

Last synced: 28 days ago
JSON representation

Cookiecutter Template for sphinx-revealjs

• Host: GitHub
• URL: https://github.com/ryu22e/cookiecutter-sphinx-revealjs
• Owner: ryu22e
• License: mit
• Created: 2022-04-27T13:07:00.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-18T00:53:36.000Z (about 2 years ago)
• Last Synced: 2024-05-18T01:35:48.568Z (about 2 years ago)
• Topics: cookiecutter, cookiecutter-template, presentation-slides, reveal-js, revealjs, sphinx
• Language: Python
• Homepage:
• Size: 668 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# cookiecutter-sphinx-revealjs

Cookiecutter Template for sphinx-revealjs.

You can easily create presentation slides to publish on GitHub Pages.

This is recommended for people who:

* Want to create slides using their preferred text editor

* Are familiar with reStructuredText or Markdown

* Have experience using Sphinx

## Usage

```shell

$ cookiecutter gh:ryu22e/cookiecutter-sphinx-revealjs

  [1/17] project_name (cookiecutter sphinx revealjs):

  [2/17] project_slug (cookiecutter-sphinx-revealjs):

  [3/17] title (Example):

  [4/17] Select python_version

    1 - 3.13

    2 - 3.12

    3 - 3.11

    4 - 3.10

    Choose from [1/2/3/4] (1):

  [5/17] site_url (https://example.com):

  [6/17] copyright_year (2024):

  [7/17] author_name (Ryuji Tsutsui):

  [8/17] release (1.0):

  [9/17] language (ja):

  [10/17] enable_budoux (y):

  [11/17] enable_robots_txt (y):

  [12/17] enable_favicon (y):

  [13/17] disable_title_uppercase (n):

  [14/17] enable_embed_video (n):

  [15/17] Select style

    1 - reStructuredText

    2 - Markdown

    Choose from [1/2] (1):

  [16/17] Select revealjs_style_theme

    1 - black

    2 - white

    3 - league

    4 - beige

    5 - sky

    6 - night

    7 - serif

    8 - simple

    9 - solarized

    10 - blood

    11 - moon

    Choose from [1/2/3/4/5/6/7/8/9/10/11] (1):

  [17/17] Select license

    1 - CC BY 4.0

    2 - None

    Choose from [1/2] (1):

$ cd cookiecutter-sphinx-revealjs

$ python3 -m venv .venv

$ source .venv/bin/activate

(.venv)$ pip install -r requirements.txt

(.venv)$ playwright install --with-deps chromium  # Run only once initially

(.venv)$ make revealjs

(.venv)$ ls build/revealjs

_sources    _static     favicon.ico index.html  objects.inv robots.txt

```

## Setting up GitHub Pages

![Setting up GitHub Pages](./img/setting-up-github-pages.jpg "Setting up GitHub Pages")