# Markup

Misago defines custom `misago.markup` module that provides facilities for parsing strings.

This module exposes following functions as its public API:

### misago.markup.parse(text, author=None, allow\_mentions=True, allow\_links=True, allow\_images=True, allow\_blocks=True)

Parses Misago-flavoured Markdown text according to settings provided. Returns dictionary with following keys:

* `original_text` - original text that was parsed
* `parsed_text` - parsed text
* `markdown` - markdown instance

### misago.markup.common\_flavour(text, author=None, allow\_mentions=True)

Convenience function that wraps `parse()`. This function is used for parsing messages.

## Extending Markup

To extend Misago markup, create custom module defining one or both of following functions:

### `extend_markdown(md)`

Defining this function will allow you to register new extensions in markdown used to parse text.

### `process_result(result, soup)`

This function is called to allow additional changes in result dict as well as extra instrospection and cleanup of parsed text, which is provided as [Beautiful Soup](http://www.crummy.com/software/BeautifulSoup/bs4/doc/) class instance.

Both functions should modify provided arguments in place.

Once your functions are done, add path to your module to `MISAGO_MARKUP_EXTENSIONS` setting like this:

```python
# inside your settings.py...
MISAGO_MARKUP_EXTENSIONS = [
    'mymodule.markupextensions',
]
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://misago.gitbook.io/docs/markup.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.