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.

Source Distribution

Argot-0.4.tar.gz (8.8 kB view details)

Uploaded Source

File details

Details for the file Argot-0.4.tar.gz.

File metadata

  • Download URL: Argot-0.4.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Argot-0.4.tar.gz
Algorithm Hash digest
SHA256 49a93efd04327c21b9853dd3f9238c90e303743f43f9581e3ea42650a6308238
MD5 c7dad3430c36c183b1d86471d3ca9316
BLAKE2b-256 1758aa2a0271bafbb3474a77aa4de28255b39148d647e157405e00ab0936aa2b

See more details on using hashes here.

Supported by

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