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>

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.6.1.tar.gz (18.5 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.6.1-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: marquedown-0.6.1.tar.gz
  • Upload date:
  • Size: 18.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.4 Linux/5.10.109-1-MANJARO

File hashes

Hashes for marquedown-0.6.1.tar.gz
Algorithm Hash digest
SHA256 9e3710ded59ade955f1eb2f6c2af7d369a209fb3592c9f34c7d2037a953da9df
MD5 165580d93a486f548d816127a8e23a2c
BLAKE2b-256 ac72f56057b95e2f5e32a81a8ea7ab1ef6ded41cac8ec75adf6adca927f3ab33

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for marquedown-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 909b34e76b1c34f16159d694f9fa9213178ca98defe1c46e3bc18c9fa1134fe4
MD5 2702e7fc9f027d2a16983ad73d981bce
BLAKE2b-256 2b7b4410a210fd73654715c991d4a3e7c42f7ef9880b9f77a60b75608c368b8a

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