-
plugins.py
None
-
create_covers.py
None
-
feeds.py
The
markata.plugins.feeds
plugin is used to create feed pages, which are lists of posts. The list is generated using afilter
, then each post in the list is rendered with acard_template
before being applied to thebody
of thetemplate
. -
auto_description.py
A Markata plugin to create automatic descriptions for markdown documents. It does this by grabbing the first
{len}
number of characters from the document that are in a paragraph. -
pyinstrument.py
Markata plugin to create a pyinstrument profile if pyinstrument is installed.
-
mdit_details.py
None
-
prevnext.py
The prevnext plugin, creates previous and next links inside each post.
-
__init__.py
None
-
rss.py
Default glob plugin
-
datetime.py
Default datetime plugin
-
icon_resize.py
Icon Resize Plugin
-
service_worker.py
Adds a service_worker to your site. This will make it installable on mobile, viewable offline, and potentially more responsive as the user goes between good and bad connections.
-
md_it_wikilinks.py
Wikilinks depicted with
\[[wikilinks]]
can be enabled for sites using themarkdown-it-py
plugin markata will look through all posts matching up the file stem to the wiki link and inserting the slug as the href. -
manifest.py
manifest plugin
-
docs.py
leading docstring
-
render_markdown.py
Renders markdown content as html. This may be markdown files loaded in by way of the load plugin.
-
post_template.py
Add head configuration
This snippet allows users to configure their head in
markata.toml
. -
tui.py
None
-
copy_assets.py
None
-
covers.py
Configuration
Example configuration. Covers supports multiple covers to be configured. Here is an example from my blog where we have a template sized for dev.to and one sized for open graph. Each image takes it's own configuration.
-
subroute.py
None
-
sitemap.py
None
-
publish_dev_to_source.py
None
-
flat_slug.py
The articles slug is what determines the url to your page. It should be sanitized of special characters that do not work in the browser.
-
md_it_highlight_code.py
None
-
setup_logging.py
Setup Logging hook sets up the RichHandler for pretty console logs, and file logs to the configured markata's configured
log_dir
, oroutput_dir/_logs
iflog_dir
is not configured. The log file will be named after the<levelname>.log
-
generator.py
add generator meta tag
-
redirects.py
Creates redirects for times when your backend server can't.
-
publish_source.py
Writes the final modified markdown and frontmatter to the output directory. Replacing the trailing slash if its there and adding .md will bring up the raw source.
-
load.py
Default load plugin.
-
heading_link.py
Creates links next to all heading tags to make it easier for users to share a specific heading.
-
publish_html.py
Sets the articles
output_html
path, and saves the article'shtml
to theoutput_html
file. -
auto_title.py
None
-
jinja_md.py
Renders your markdown as a jinja template during pre_render.
-
seo.py
manifest plugin
-
to_json.py
None
-
glob.py
Default glob plugin
-
base_cli.py
Markata's base command line commands.