None

conftest.py

None

test_redirects.py

Tests the redirects plugin

test_flat_slug.py

None

test_doc_page.py

None

test_one_default_page_with_path_prefix.py

None

test_feeds.py

None

test_one_default_page.py

None

__main__.py

None

__init__.py

None

header.py

None

plugins.py

None

cli.py

None

summary.py

Run it





        
python -m markata.cli.summary

Configuration

There are two main things currently supported by summary, It can count the number of posts based on a filter (filter_count'), and it can automatically list all the values of an attribute and the number of posts that have that attribute (grid_attr`).

runner.py

None

server.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 a filter, then each post in the list is rendered with a card_template before being applied to the body of the template.

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 the markdown-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, or output_dir/_logs if log_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's html to the output_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.

migrate_to_slugify.py

Slugify migration for projects moving from markata<0.5.0 into markata>=0.5.0

__main__.py

None

__init__.py

Markata is a tool for handling directories of markdown.

hookspec.py

Define hook specs.

errors.py

None

lifecycle.py

The LifeCycle is a core component for the internal workings of Markata. It sets fourth the hooks available, the methods to run them on the Markata instance, and the order they run in.

__about__.py

None

standard_config.py

Standard Config. A module to load tooling config from a users project space.

Changelog

Markata Changelog

0.7.0

Adopt ruff linter 0.7.0.dev1 #142

0.6.0

Fix: article_html is not available to jinja 0.6.0.dev1 #105
Fix: service worker is not upating client without hard refresh 0.6.0.dev2 #106
Feat: create teardown lifecycle method 0.6.0.dev3 #110
Fix: implement teardown on all raises 0.6.0.dev4 #111
Fix: implement teardown in pyinstrument plugin 0.6.0.dev5 #112
Feat: Automatically call teardown without needing to remember it before raise 0.6.0.dev6 #113
Fix: only stop the profiler if it is running 0.6.0.dev7 #114
Fix: map was giving inconsistent results 0.6.0.dev8 #116
Fix: tui continuously rebuilds if an input file exists in a parent directory to the output directory 0.6.0.dev9 #118
Feat: report the cache stats for the current run 0.6.0.dev11 #121
Fix: prevent zerodivisionerror when reporting stats 0.6.0.dev12 #122
Fix: properly set the pyinstrument profiler to prevent recurrsion errors 0.6.dev13 #123
Clean: cli attributes (runner, summary, server, plugins) are now added as Markata properties through register_atter rather than directly to the class 0.6.0.dev13 #107
Fix: Markata tui will remain running even when the runner fails 0.6.0.dev13 #107
Fix: Pinned to textual<0.2.0 due to breaking changes 0.6.0.dev13 #107
Fix: snyk remove seuptools from requirements 0.6.0.dev14 #130
Fix: Markata.filter was missing post and m 0.6.0.dev14 #133
Feat: add path_prefix config for gh-pages deploy 0.6.0.dev15 #132 fixes #57
Feat: created markata plugin show cli command 0.6.0.dev16 #109
Feat: use path_prefix in nav entries 0.6.0.dev17 #136
Feat: enable wikilinks extension by default 0.6.0.dev18 #138
Feat: markata instance is available form inside card_template for feeds 0.6.0.dev19 #139

wikilinks

wikilinks are now enabled by default ex: [[home-page]]. This will create a link <a class="wikilink" href="/home-page/">home-page</a>. This will automagically just work if you leave markata.plugins.flat_slug plugin enabled (which is by default).

WaylonWalker.com

[!Waylonwalker.com home page](https://waylonwalker.com)

Markata's Docs

[!Markta.dev home page](https://markata.dev)

Creating your Home Page

There are several ways to create your home/landing page, lets walk through them.

Whoops that page was not found

404, looks like we can't find the page you are looking for. Try one of these pages.

Theming your markata site

Default colors

The default markata page template support the following colors to be configured in the markata.toml file. There are two sets of similarly named colors, one for light theme and one for dark. The default page template will set these colors based on the users prefers-color-scheme.

Getting Started with Markata

Markata is a fully plugins all the way down static site generator for folks who just want their site to get started quickly and build great content, with the ability to tinker with everything under the hood if they want to.

Creating your Navbar

Creating navbar links with the default markata templates is done by adding links in your markata.toml configuration within a markata.nav block.

All Markata Modules

Run it

Configuration

Add head configuration

Configuration

Markata Changelog

0.7.0

0.6.0

wikilinks

Default colors