Skip to main content

This plugin allows to embed a Pico-8 web player in a mkdocs generated page.

Project description

Pico-8 (MkDocs Plugin)

This mkdocs plugin look in each MkDocs article for the presence of a tag like this:

{{ pico-8: 12345 }}

Then, it will replace it with a web player that will allow the reader of a page to enjoy pico-8 games through the page.

To install it, edit your mkdocs.yml file and add these few lines of code:

plugins:
   - hello-dolly

An example

For example, you could edit the docs/index.md file and insert the tag in any place, like this:

# Welcome to MkDocs

For full documentation visit [mkdocs.org](http://mkdocs.org).

{{ pico-8: 46052 }}

## Commands

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pico8-mkdocs-plugin-1.0.0.tar.gz (2.3 kB view details)

Uploaded Source

Built Distribution

pico8_mkdocs_plugin-1.0.0-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file pico8-mkdocs-plugin-1.0.0.tar.gz.

File metadata

  • Download URL: pico8-mkdocs-plugin-1.0.0.tar.gz
  • Upload date:
  • Size: 2.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for pico8-mkdocs-plugin-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e0a08101497e2aaed2c977ed1d4270fc78010f9124a6149885e3990bc0363fde
MD5 98df67bbafb80e7222ab58e47fc539cb
BLAKE2b-256 5994dbe36357bea62a52d3b9814a5850cef3770d784fb2b5aa2c608a6466abed

See more details on using hashes here.

File details

Details for the file pico8_mkdocs_plugin-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: pico8_mkdocs_plugin-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for pico8_mkdocs_plugin-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 53857cb5d292d9ce74e5ece1f76b7879a952625afd60711be2faecb26c97a452
MD5 981be6348e58f47961903a08d8dbb55e
BLAKE2b-256 23d6eb66abac0ffa6b3803b3eb286881a7d66eedbb8ecae5ac7a5f0dad9e6d98

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page