Skip to main content

Extending Markdown further by adding a few more useful notations.

Project description

Marquedown

Extending Markdown further by adding a few more useful notations. It can be used in place of markdown as it also uses and applies it.

Examples

Blockquote with citation

This is currently limited to the top scope with no indentation. Surrounding dotted lines are optional.

......................................................
> You have enemies? Good. That means you've stood up
> for something, sometime in your life.
-- Winston Churchill
''''''''''''''''''''''''''''''''''''''''''''''''''''''
<blockquote>
    <p>
        You have enemies? Good. That means you've stood up
        for something, sometime in your life.
    </p>
    <cite>Winston Churchill</cite>
</blockquote>

Embed video

YouTube

![dimweb](https://youtu.be/VmAEkV5AYSQ "An embedded YouTube video")
<iframe
    src="https://www.youtube.com/embed/VmAEkV5AYSQ"
    title="An embedded YouTube video" frameborder="0"
    allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
    allowfullscreen>
</iframe>

Commands

render: Render documents

You can render an entire directory and its subdirectories of Markdown or Marquedown documents. This can be used to automate rendering pages for your website.

Do python -m marquedown render --help for list of options.

Example

For a few of my websites hosted on GitLab, I have it set up to run this on push:

# Render document
python -m marquedown render -i ./md -o ./public -t ./templates/page.html

# This is for the GitLab Pages publication
mkdir .public
cp -r public .public
mv .public public  

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

marquedown-0.5.0.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

marquedown-0.5.0-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

Details for the file marquedown-0.5.0.tar.gz.

File metadata

  • Download URL: marquedown-0.5.0.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.10.105-1-MANJARO

File hashes

Hashes for marquedown-0.5.0.tar.gz
Algorithm Hash digest
SHA256 63591bfcd1d1212d1ebff70a97c4c84d22046713e77f20b5ac84fb4c881a364e
MD5 21c4151de120985fef7941065b267e17
BLAKE2b-256 8167b80e7d7bf84e7f890e1d185dc749f57f2ee55086e3b0d0e210fe8129f35d

See more details on using hashes here.

File details

Details for the file marquedown-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: marquedown-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.10.105-1-MANJARO

File hashes

Hashes for marquedown-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8cd68f6aa5da1324e957e6b477a85c3c4fdbc243e0db546b5eb703f8e05bcc55
MD5 0bd0d3e995e15432e6f769eab64af8dc
BLAKE2b-256 340f298601ed47e3ce066739420a60885fa4651611b494ee467b2746a5bb0ae4

See more details on using hashes here.

Supported by

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