Skip to main content

argot text markup -- a markdown dialect

Project description

Argot is a small set of extensions on the markdown markup language designed primarily for writing technical blog entries. The extensions are not “proper” markdown extensions; they are implemented as preprocessors that compile down into markdown or html syntax. In addition to markdown’s regular syntax, which argot does not interfere with, argot provides these features:

You can fork argot from its hg repository.

requirements

argot requires markdown, pygments, and lxml. lxml can be difficult to install from pypi, so it is not listed as an installation requirement in setup.py. Please fulfill this requirement through lxml’s OS bundles.

moin-style highlighted code blocks

In markdown, code blocks are blocks of text one level of indentation removed from the body text. However, when dealing with more primative browser input mechanisms, indenting lots of text can be problematic (as tab often shifts input focus). In addition to allowing for this convention, argot implements moin/tracwiki style code blocks that feature syntax highlighting via pygments.

syntax

The general syntax is ‘{{{‘ followed by an optional shebang and desired pygments parser, followed by your code block, and bookended with ‘}}}’:

{{{#!parser
    ... code ...
}}}

By default, if no parser is provided, argot uses pygments to try and guess what language is being used. It falls back to the plain text lexer.

Project details


Download files

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

Files for Argot, version 0.5.2
Filename, size File type Python version Upload date Hashes
Filename, size Argot-0.5.2.tar.gz (8.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page