mkdocs-slides 0.1.3

A MkDocs plugin for creating slide presentations within documentation

MkDocs Slides Plugin

A plugin for MkDocs that enables beautiful slide presentations within your documentation.

Installation

pip install mkdocs-slides

Usage

1. Add the plugin to your mkdocs.yml:

plugins:
  - slides

2. Create a slide deck in your markdown:

```slides
title: My Presentation
url_stub: my-pres
nav:
    - slides/presentation/*.md

Configuration

You can customize the plugin behavior in your mkdocs.yml:

plugins:
  - slides:
      font_size: "28px"  # Default font size for slides
      template: "layouts/slide_template.html"  # Custom slide template

Custom Templates

To use a custom template:

1. Create a layouts directory in your docs root
2. Copy the default template as a starting point:

mkdir -p layouts
cp $(python -c "import mkdocs_slides; import os; print(os.path.join(os.path.dirname(mkdocs_slides.__file__), 'templates', 'slide_template.html'))") layouts/slide_template.html

3. Modify the template to suit your needs
4. Reference it in your mkdocs.yml

For full documentation, visit the plugin documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.