https://github.com/eigenric/pelican-toggle

A Pelican plugin to add collapsible sections (details/summary elements) to your site
https://github.com/eigenric/pelican-toggle

Last synced: 27 days ago
JSON representation

A Pelican plugin to add collapsible sections (details/summary elements) to your site

• Host: GitHub
• URL: https://github.com/eigenric/pelican-toggle
• Owner: eigenric
• Created: 2024-06-28T22:11:20.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-01T12:48:21.000Z (4 months ago)
• Last Synced: 2024-07-02T11:56:11.365Z (4 months ago)
• Language: Python
• Homepage:
• Size: 187 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
pelican-toggle: A Plugin for Pelican

====================================================

[![Build Status](https://img.shields.io/github/actions/workflow/status/pelican-plugins/pelican-toggle/main.yml?branch=main)](https://github.com/eigenric/pelican-toggle/actions)

[![PyPI Version](https://img.shields.io/pypi/v/pelican-toggle)](https://pypi.org/project/pelican-toggle/)

[![Downloads](https://img.shields.io/pypi/dm/pelican-toggle)](https://pypi.org/project/pelican-toggle/)

![License](https://img.shields.io/pypi/l/pelican-toggle?color=blue)

Toggle text

Installation

------------

This plugin can be installed via:

    python -m pip install pelican-toggle

As long as you have not explicitly added a `PLUGINS` setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add `pelican_toggle` to your existing `PLUGINS` list. For more information, please see the [How to Use Plugins](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation.

Usage

-----

The `toggle` directive is used to create a disclosure widget. The directive has the following syntax:

```markdown

**Proposición** Si $S \subset X$ es un conjunto totalmente ordenado o toset y tiene un elemento maximal (resp. minimal) entonces coincide con el máximo (resp. mínimo).

{% toggle %}

Sea $m \in S$ un elemento maximal entonces no existe elemento estrictamente mayor que él. Como $S$ es toset todos los elementos son comparables y por tanto todos son menores que $m$. La unicidad se da por ser poset en particular.

Sea $n \in S$ un elemento minimal entonces no existe elemento estrictamente menor que él. Como $S$ es toset todos los elementos son comparables y por tanto todos son mayores que $n$.

{% end_toggle %}

````

And the output will be:

![show](show.png)

![toggle](output.png)

Contributing

------------

Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on [existing issues](https://github.com/getpelican/pelican/issues).

To start contributing to this plugin, review the [Contributing to Pelican](https://docs.getpelican.com/en/latest/contribute.html) documentation, beginning with the **Contributing Code** section.

License

-------

This project is licensed under the MIT license.