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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for marquedown-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 733db5ccee9978e04ca520bfbc19932ec84c329263e0a402377839d341547b5c |
|
MD5 | 8b227e9738bd39ac0ea7a1e0a31b73be |
|
BLAKE2b-256 | 7a4c02301701c2d0df1daa3a9d990caa7c15725aa970a9dd7307b897eb80f51f |