-
Whoops that page was not found
404, looks like we can't find the page you are looking for
-
Creating your Home Page
There are several ways to create your home/landing page, lets walk through them.
-
Creating your Navbar
Guide to creating a navbar in markata using the default template.
-
Getting Started with Markata
Guide to get going with Markata
-
Using Multiple Templates
Guide to using multiple templates in markata
-
Theming your markata site
Guide to get going with Markata
-
Admonitions
This is what the default admonition styles look like and how to create them.
-
Manually create a new site
Lets manually create a new website with markata.
-
Markata's Docs
[](https://markata.dev){.shadow-2xl} Markata builds it's own docs in completely in `markata` using all built in
-
WaylonWalker.com
[](https://waylonwalker.com) This Waylon Walker's personal blog where he is learning in public. Posti
-
Changelog
Markata Changelog 0.9.1 HUGE DOCS UPDATE FIX: feeds now update with any content change FIX: og tags should use property not name 0.9.0 Feat: add skip plugin Fix
-
test.py
None
-
test_feeds.py
None
-
test_redirects.py
Tests the redirects plugin !!! function <h2 id="set_directory" class="admonition-title" style="margin: 0; padding: .5rem 1rem;&q
-
test_post_model.py
None
-
__init__.py
Markata is a tool for handling directories of markdown. !!! method <h2 id="teardown" class="admonition-title" style="margin: 0;
-
hookspec.py
Markata's hook specification system for plugin development. Overview Markata uses pluggy to define hooks that plugins can implement. These hooks allow plug
-
__main__.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, an
-
exceptions.py
None
-
standard_config.py
Standard Config. A module to load tooling config from a users project space. Inspired from frustrations that some tools have a tool.ini, .tool.ini, setup.cfg, o
-
errors.py
None !!! class <h2 id="MarkataConfigError" class="admonition-title" style="margin: 0; padding: .5rem 1rem;">MarkataConfi
-
__about__.py
None
-
analytics.py
The `markata.plugins.analytics` plugin generates analytics and contribution visualizations for your Markata site. It creates a contributions heatmap similar to
-
auto_description.py
The `markata.plugins.auto_description` plugin automatically generates descriptions for your posts by extracting text from the first paragraphs of your markdown
-
rss.py
[DEPRECATED] The `markata.plugins.rss` plugin is deprecated and will be removed in a future version. Please use `markata.plugins.feeds` instead, which provides
-
mdit_details.py
The `markata.plugins.mdit_details` plugin adds support for collapsible details/summary sections in markdown using the `???` syntax. This is similar to HTML'
-
md_it_highlight_code.py
The `markata.plugins.md_it_highlight_code` plugin adds syntax highlighting to code blocks in your markdown content. It uses Pygments for highlighting and adds a
-
skip.py
Post Skipping and Caching Plugin !!! function <h2 id="post_model" class="admonition-title" style="margin: 0; padding: .5rem 1rem
-
md_it_wikilinks.py
The `markata.plugins.md_it_wikilinks` plugin adds support for wiki-style links using double brackets (`[[link]]`). It automatically resolves links to other post
-
pyinstrument.py
The `markata.plugins.pyinstrument` plugin adds performance profiling capabilities using pyinstrument. It generates detailed HTML reports showing where your buil
-
__init__.py
None
-
sitemap.py
[DEPRECATED] The `markata.plugins.sitemap` plugin is deprecated and will be removed in a future version. Please use `markata.plugins.feeds` instead, which provi
-
covers.py
The `markata.plugins.covers` plugin generates custom cover images for your posts using configurable templates. It supports multiple cover image formats with dif
-
load.py
The `markata.plugins.load` plugin is responsible for loading and parsing markdown files with frontmatter into Post objects. It provides parallel loading capabil
-
redirects.py
The `markata.plugins.redirects` plugin creates static redirects for your site using a simple configuration file. Compatible with services like Cloudflare Pages
-
datetime.py
The `markata.plugins.datetime` plugin handles date and time parsing for posts. It ensures consistent datetime handling by converting various date formats to tim
-
prevnext.py
The `markata.plugins.prevnext` plugin adds previous and next navigation links to each post, allowing readers to easily navigate between related content. Install
-
create_models.py
The `markata.plugins.create_models` plugin dynamically creates Markata's core Pydantic models by combining model fragments from various plugins. This enabl
-
config_model.py
The `markata.plugins.config_model` plugin defines Markata's core configuration model, providing validation and type safety for all configuration options. I
-
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 i
-
seo.py
manifest plugin
-
copy_assets.py
The `markata.plugins.copy_assets` plugin copies static assets (images, CSS, JavaScript, etc.) from your assets directory to the output directory during the buil
-
create_covers.py
The `markata.plugins.create_covers` plugin is a simplified version of the covers plugin. It generates basic cover images with titles using a single template and
-
jinja_md.py
The `markata.plugins.jinja_md` plugin enables Jinja2 templating within your markdown content. This allows you to dynamically generate content using Python expre
-
docs.py
The `markata.plugins.docs` plugin automatically generates documentation pages from Python source code docstrings. It parses Python files, extracts docstrings an
-
tui.py
None
-
post_model.py
The `markata.plugins.post_model` plugin defines the core Post model used throughout Markata. It provides robust validation, serialization, and configuration opt
-
publish_html.py
The `markata.plugins.publish_html` plugin handles saving rendered HTML content to files. It determines the output path for each article and ensures files are sa
-
post_template.py
The `markata.plugins.post_template` plugin handles the rendering of posts using Jinja2 templates. It provides extensive configuration options for HTML head elem
-
to_json.py
None
-
base_cli.py
The `markata.plugins.base_cli` plugin provides Markata's core command-line interface functionality, including essential commands like `build`, `list`, and
-
auto_title.py
The `markata.plugins.auto_title` plugin automatically generates titles for posts that don't have a title specified in their frontmatter. It uses the filena
-
publish_source.py
The `markata.plugins.publish_source` plugin saves processed markdown files to the output directory, preserving frontmatter and content modifications. This enabl
-
publish_dev_to_source.py
The `markata.plugins.publish_dev_to_source` plugin enables synchronization between your Markata posts and dev.to articles. It handles frontmatter translation an
-
glob.py
The `markata.plugins.glob` plugin handles file discovery using glob patterns. It determines which files should be processed by Markata based on configured patte
-
render_markdown.py
The `markata.plugins.render_markdown` plugin converts markdown content to HTML. This plugin is essential for rendering markdown files loaded by the `load` plugi
-
icon_resize.py
The `markata.plugins.icon_resize` plugin automatically generates favicons in multiple sizes from a single source image. This ensures your site has appropriate i
-
subroute.py
None
-
flat_slug.py
The `markata.plugins.flat_slug` plugin handles URL slug generation for your articles. It sanitizes special characters that don't work in browsers and provi
-
generator.py
The `markata.plugins.generator` plugin adds a meta generator tag to each generated HTML page, indicating that the page was generated by Markata and including th
-
heading_link.py
The `markata.plugins.heading_link` plugin adds clickable link icons next to headings in your HTML output. This makes it easy for readers to share direct links t
-
manifest.py
The `markata.plugins.manifest` plugin generates a Web App Manifest (manifest.json) file for your site. This enables Progressive Web App (PWA) features and provi
-
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 an
-
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` i
-
didyoumean.py
DidYouMean Plugin for Markata Automatically generates redirect pages for URLs that may be mistyped by users. Installation Configuration Usage This plugin will g
-
migrate_to_slugify.py
Slugify migration for projects moving from markata<0.5.0 into markata>=0.5.0 to run this script install markata>=0.5.0 and run the following. Then make
-
server.py
None !!! function <h2 id="find_port" class="admonition-title" style="margin: 0; padding: .5rem 1rem;">find_port <em c
-
__init__.py
None
-
cli.py
None !!! function <h2 id="make_layout" class="admonition-title" style="margin: 0; padding: .5rem 1rem;">make_layout <
-
runner.py
None !!! class <h2 id="Runner" class="admonition-title" style="margin: 0; padding: .5rem 1rem;">Runner <em class=&quo
-
__main__.py
None
-
summary.py
Run it 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
-
header.py
None !!! class <h2 id="Header" class="admonition-title" style="margin: 0; padding: .5rem 1rem;">Header <em class=&quo
-
plugins.py
None
-
didyoumean.py
dummy didyoumean page for testing didyoumean suggestions