Argot 0.3

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. These codeblocks are actually compiled down to a pseudo markdown/html syntax that looks something like this:

<code style="parser">
    ... code ...
</code>

As a later pre-processing step, blocks of this style are temporarily removed from the body text and replaced by a token. Markdown is then run over the rest of the document, and the token is replaced with the syntax highlighted code. As a result, you can achieve syntax highlighted code by using the raw syntax as the highlight step is agnostic to where the code came from.

syntax

Link processors are made up of the processor tag, followed by a colon, followed by a query for that processor. For example:

[Quick reStructured Text](google: restructured text quick ref)

This calls the link processor google with the query restructured text quick ref. By default, only the link processor google is enabled. There is an amazon link processor that can be enabled, but it is suggested that for stable queries you append ‘amazon’ to google queries.

writing new link processors

Link processors are functions that take a single argument, the query as a string, and return another string:

def wiki_processor(query):
    return google_processor('wikipedia %s' % query)
argot.enable_link_processor(wiki_processor)

This hypothetical wiki processor merely does a google search for ‘wikipedia’ and the query provided. The tag for the processor can be provided in 3 ways:

• the name of the function before the first underscore

• a tag attribute on the function

• an optional second argument to enable_link_processor