Macros Plugin Environment

Default mkdocs_macro List the defined variables

Test/debug function: list useful documentation on the mkdocs_macro environment.

Get the current time (returns a datetime object). Used alone, it provides a timestamp. To get the year use now().year, for the month number now().month, etc.

If url is relative, fix it so that it points to the docs diretory. This is necessary because relative links in markdown must be adapted in html ('img/foo.png' => '../img/img.png').

Default mkdocs_macro Prettify a dictionary or object (used for environment documentation, or debugging).

Return the absolute value of the argument.

Get an attribute of an object. foo|attr("bar") works like foo.bar just that always an attribute is returned and items are not looked up.

A filter that batches items. It works pretty much like slice just the other way round. It returns a list of lists with the given number of items. If you provide a second parameter this is used to fill up missing items. See this example.

Capitalize a value. The first character will be uppercase, all others lowercase.

Centers the value in a field of a given width.

Return the number of items in a container.

If the value is undefined it will return the passed default value, otherwise the value of the variable.

If the value is undefined it will return the passed default value, otherwise the value of the variable.

Sort a dict and yield (key, value) pairs. Python dicts may not be in the order you want to display them in, so sort them first.

Replace the characters &, <, >, ', and " in the string with HTML-safe sequences. Use this if you need to display text that might contain such characters in HTML.

Replace the characters &, <, >, ', and " in the string with HTML-safe sequences. Use this if you need to display text that might contain such characters in HTML.

Format the value like a 'human-readable' file size (i.e. 13 kB, 4.1 MB, 102 Bytes, etc). Per default decimal prefixes are used (Mega, Giga, etc.), if the second parameter is set to True the binary prefixes are used (Mebi, Gibi).

Return the first item of a sequence.

Convert the value into a floating point number. If the conversion doesn't work it will return 0.0. You can override this default using the first parameter.

Enforce HTML escaping. This will probably double escape variables.

Apply the given values to a printf-style_ format string, like string % values.

Group a sequence of objects by an attribute using Python's :func:itertools.groupby. The attribute can use dot notation for nested access, like "address.city". Unlike Python's groupby, the values are sorted first so only one group is returned for each unique value.

Return a copy of the string with each line indented by 4 spaces. The first line and blank lines are not indented by default.

Convert the value into an integer. If the conversion doesn't work it will return 0. You can override this default using the first parameter. You can also override the default base (10) in the second parameter, which handles input with prefixes such as 0b, 0o and 0x for bases 2, 8 and 16 respectively. The base is ignored for decimal numbers and non-string values.

Return a string which is the concatenation of the strings in the sequence. The separator between elements is an empty string per default, you can define it with the optional parameter.

Return the last item of a sequence.

Return the number of items in a container.

Convert the value into a list. If it was a string the returned list will be a list of characters.

Convert a value to lowercase.

Applies a filter on a sequence of objects or looks up an attribute. This is useful when dealing with lists of objects but you are really only interested in a certain value of it.

Return the smallest item from the sequence.

Return the largest item from the sequence.

Pretty print a variable. Useful for debugging.

Return a random item from the sequence.

Filters a sequence of objects by applying a test to each object, and rejecting the objects with the test succeeding.

Filters a sequence of objects by applying a test to the specified attribute of each object, and rejecting the objects with the test succeeding.

Return a copy of the value with all occurrences of a substring replaced with a new one. The first argument is the substring that should be replaced, the second is the replacement string. If the optional third argument count is given, only the first count occurrences are replaced.

Reverse the object or return an iterator that iterates over it the other way round.

Round the number to a given precision. The first parameter specifies the precision (default is 0), the second the rounding method.

Mark the value as safe which means that in an environment with automatic escaping enabled this variable will not be escaped.

Filters a sequence of objects by applying a test to each object, and only selecting the objects with the test succeeding.

Filters a sequence of objects by applying a test to the specified attribute of each object, and only selecting the objects with the test succeeding.

Slice an iterator and return a list of lists containing those items. Useful if you want to create a div containing three ul tags that represent columns.

Sort an iterable using Python's :func:sorted.

Convert an object to a string if it isn't already. This preserves a :class:Markup string rather than converting it back to a basic string, so it will still be marked as safe and won't be escaped again.

Strip SGML/XML tags and replace adjacent whitespace by one space.

Returns the sum of a sequence of numbers plus the value of parameter 'start' (which defaults to 0). When the sequence is empty it returns start.

Return a titlecased version of the value. I.e. words will start with uppercase letters, all remaining characters are lowercase.

Strip leading and trailing characters, by default whitespace.

Return a truncated copy of the string. The length is specified with the first parameter which defaults to 255. If the second parameter is true the filter will cut the text at length. Otherwise it will discard the last word. If the text was in fact truncated it will append an ellipsis sign ("..."). If you want a different ellipsis sign than "..." you can specify it using the third parameter. Strings that only exceed the length by the tolerance margin given in the fourth parameter will not be truncated.

Returns a list of unique items from the given iterable.

Convert a value to uppercase.

Quote data for use in a URL path or query using UTF-8.

Convert URLs in text into clickable links.

Count the words in that string.

Wrap a string to the given width. Existing newlines are treated as paragraphs to be wrapped separately.

Create an SGML/XML attribute string based on the items in a dict. All values that are neither none nor undefined are automatically escaped.

Serialize an object to a string of JSON, and mark it safe to render in HTML. This filter is only for use in HTML documents.