https://github.com/iranzo/pelican-revealmd

Repository for pelican-revealmd plugin
https://github.com/iranzo/pelican-revealmd

Last synced: 10 days ago
JSON representation

Repository for pelican-revealmd plugin

• Host: GitHub
• URL: https://github.com/iranzo/pelican-revealmd
• Owner: iranzo
• Created: 2021-01-14T20:55:26.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-08T13:23:48.000Z (3 months ago)
• Last Synced: 2024-10-07T10:09:31.313Z (about 1 month ago)
• Language: HTML
• Size: 129 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# pelican-revealmd

Reveal-md allows you to write reveal.js presentations in markdown, in the same way you write markdown

posts for pelican.

```markdown

Title: My awesome presentation

Date: 2018-08-08

Category: talks

Summary: This is my summary

# Presentation

With reveal.js!

# Second slide

With whatever you want here

```

# Showing your work on your website

Pelican does render markdown into html, but for revealjs a different set of changes need to be taken into consideration, hence, this plugin will help as long as you follow some steps:

Save your file as `my_presentation.revealjs`, add

```python

PLUGINS = ["revealmd"]

```

to your `pelicanconf.py` and your presentation will be automatically rendered for you using the required `pandoc` utility installed on your system.

You also need to use the provided html template instead of trying to embed the presentation within the templates provided by your theme. Revealmd provides a revealmd html template for this purpose, but in your configuration file, the templates path needs to be specified:

```python

EXTRA_TEMPLATES_PATHS = [

    "path/to/revealmd/templates",  # eg: "plugins/revealmd/templates"

]

```

If you use git to manage your site, you could do something like

```

git submodule add https://github.com/iranzo/pelican-revealmd.git plugins/revealmd

```

to install the plugin

# Additional information

The process of conversion and showing the presentation might alter it (will not directly show as good as with reveal-md), this happens because:

- This plugin does use `pandoc`, the conversion it performs might alter the data, for example, losing horizontal-vertical slides and others.