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>

BBCode HTML tags

These tags allow you to put Marquedown inside HTML tags. This is done by finding and replacing them with their represented HTML after all other Marquedown has been rendered.

Tags and classes

The naming scheme is the same as in CSS, e.g. tag.class1.class2 If tag is omitted, it is treated to be div

ID:s

ID:s are supported using #beans at the end of the tag, ex. [p#beans]

[section]
[.bingo]
A regular **paragraph** written in Marquedown, but *within* other HTML tags.
[//]

[tag.class1.class2] [/tag]
<section>
<div class="bingo">
    <p>
        A regular <strong>paragraph</strong> written in Marquedown, but <em>within</em> other HTML tags.
    </p>
</div></section>

<tag class="class1 class2"> </tag>

Label list

(| email: [jon@webby.net](mailto:jon@webby.net)
(| matrix: [@jon:webby.net](https://matrix.to/#/@jon:webby.net)
(| runescape: jonathan_superstar1777
<ul class="labels">
    <li class="label label-email">
        <a href="mailto:jon@webby.net">
            jon@webby.net
        </a>
    </li>
    <li class="label label-matrix">
        <a href="https://matrix.to/#/@jon:webby.net">
            @jon:webby.net
        </a>
    </li>
    <li class="label label-runescape">
        jonathan_superstar1777
    </li>
</ul>

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.8.0.tar.gz (20.3 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.8.0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: marquedown-0.8.0.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.5 Linux/5.10.133-1-MANJARO

File hashes

Hashes for marquedown-0.8.0.tar.gz
Algorithm Hash digest
SHA256 bb15f9ea1c0694ff93468aed72382b0df667f1db6ab03d8c873d64e5b2a2ccae
MD5 3a6e3a1ff096af201328b03a5b2c7ae7
BLAKE2b-256 210d0ed5b43d3f97c4030a4f7846a94ff360d1c5947ea4cd058875d726f88c47

See more details on using hashes here.

File details

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

File metadata

  • Download URL: marquedown-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.5 Linux/5.10.133-1-MANJARO

File hashes

Hashes for marquedown-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c732572e66abe1e3e84c17719915a86b1e991106dcc39fb9b7132c95980797a
MD5 31905ba6cee6cb0d5b214715ff6d58e9
BLAKE2b-256 4bb86f7553536423e5c29c467f642d6d64d328bcda9ac78d5076f99d95243800

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