-
Creating your Navbar
Creating navbar links with the default markata templates is done by adding links in your configuration within a block. Example The following example will…
-
Theming your markata site
Default colors The default markata page template support the following colors to be configured in the file. There are two sets of similarly named colors,…
-
Using Multiple Templates
This page will be rendered multiple times. This is the normal page, check out og . It uses the og.html. This is achieved through the use of the template…
-
Creating your Home Page
There are several ways to create your home/landing page, lets walk through them. Default Behavior feed By default if there is no index page, the feed plugin…
-
Admonitions
???+ note open by default you can open a details tab with '+' !!! important inside of admonitions need four leading spaces. ??? note closed by default you can…
-
Whoops that page was not found
404, looks like we can't find the page you are looking for. Try one of these pages.
-
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…
-
Manually create a new site
Markata has some templates that let you get up and running quickly, but you can make a site with only markdown if you wanted. Installation is hosted on pypi…
-
WaylonWalker.com
Waylonwalker.com home page This Waylon Walker's personal blog where he is learning in public. Posting about topics such as linux, vim, python, and kedro.…
-
Markata's Docs
Markta.dev home page {.shadow-2xl} Markata builds it's own docs in completely in using all built in templatates and plugins. Markta.dev home page…
-
Changelog
Markata Changelog 0.9.2 Fix: now more accuratetly returns plain text, does not cut off words, and add an ellipsis. 0.9.1 HUGE DOCS UPDATE Fix: feeds now…
-
test.py
None
-
test_feeds.py
None
-
test_redirects.py
Tests the redirects plugin !!! function set_directory function ???+ source "set_directory source " !!! function test_redirect_exists function ???+ source…
-
test_post_model.py
None
-
errors.py
None !!! class MarkataConfigError class ???+ source "MarkataConfigError source "
-
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,…
-
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,…
-
__main__.py
None
-
hookspec.py
Markata's hook specification system for plugin development. Overview Markata uses pluggy to define hooks that plugins can implement. These hooks allow plugins…
-
exceptions.py
None
-
__about__.py
None
-
__init__.py
Markata is a tool for handling directories of markdown. !!! method teardown method ???+ source "teardown source " !!! method _compile_sort_key method ???+…
-
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 sure…
-
jinja_md.py
The plugin enables Jinja2 templating within your markdown content. This allows you to dynamically generate content using Python expressions and access to…
-
to_json.py
None
-
pyinstrument.py
The plugin adds performance profiling capabilities using pyinstrument. It generates detailed HTML reports showing where your build spends time. Installation…
-
md_it_wikilinks.py
The plugin adds support for wiki-style links using double brackets ( ). It automatically resolves links to other posts in your site using file names or…
-
mdit_details.py
The plugin adds support for collapsible details/summary sections in markdown using the syntax. This is similar to HTML's element but with a more…
-
flat_slug.py
The plugin handles URL slug generation for your articles. It sanitizes special characters that don't work in browsers and provides a consistent URL…
-
md_it_highlight_code.py
The plugin adds syntax highlighting to code blocks in your markdown content. It uses Pygments for highlighting and adds a copy button for easy code sharing.…
-
didyoumean.py
DidYouMean Plugin for Markata Automatically generates redirect pages for URLs that may be mistyped by users. Installation Configuration Usage This plugin will…
-
post_model.py
The plugin defines the core Post model used throughout Markata. It provides robust validation, serialization, and configuration options for all post…
-
docs.py
The plugin automatically generates documentation pages from Python source code docstrings. It parses Python files, extracts docstrings and code structure,…
-
feeds.py
The plugin is used to create feed pages, which are lists of posts. The list is generated using a , then each post in the list is rendered with a before…
-
publish_source.py
The plugin saves processed markdown files to the output directory, preserving frontmatter and content modifications. This enables source file access…
-
setup_logging.py
Setup Logging hook sets up the RichHandler for pretty console logs, and file logs to the configured markata's configured , or if is not configured. The…
-
publish_html.py
The plugin handles saving rendered HTML content to files. It determines the output path for each article and ensures files are saved in the correct location…
-
icon_resize.py
The plugin automatically generates favicons in multiple sizes from a single source image. This ensures your site has appropriate icons for different devices…
-
auto_description.py
The plugin automatically generates descriptions for your posts by extracting text from the first paragraphs of your markdown content. It can create multiple…
-
redirects.py
The plugin creates static redirects for your site using a simple configuration file. Compatible with services like Cloudflare Pages and Netlify.…
-
publish_dev_to_source.py
The plugin enables synchronization between your Markata posts and dev.to articles. It handles frontmatter translation and content formatting for dev.to…
-
covers.py
The plugin generates custom cover images for your posts using configurable templates. It supports multiple cover image formats with different sizes, fonts,…
-
analytics.py
The plugin generates analytics and contribution visualizations for your Markata site. It creates a contributions heatmap similar to GitHub's contribution…
-
load.py
The plugin is responsible for loading and parsing markdown files with frontmatter into Post objects. It provides parallel loading capabilities and handles…
-
glob.py
The plugin handles file discovery using glob patterns. It determines which files should be processed by Markata based on configured patterns. A glob is a…
-
seo.py
manifest plugin
-
post_template.py
The plugin handles the rendering of posts using Jinja2 templates. It provides extensive configuration options for HTML head elements, styling, and template…
-
subroute.py
None
-
jinja_env.py
Jinja2 Environment Plugin Provides a centralized Jinja2 environment configuration for consistent template rendering across all Markata plugins. This plugin…
-
datetime.py
The plugin handles date and time parsing for posts. It ensures consistent datetime handling by converting various date formats to timezone-aware datetime…
-
prevnext.py
The plugin adds previous and next navigation links to each post, allowing readers to easily navigate between related content. Installation This plugin is…
-
skip.py
Post Skipping and Caching Plugin !!! function post_model function ???+ source "post_model source " !!! function load function ???+ source "load source "…
-
config_model.py
The plugin defines Markata's core configuration model, providing validation and type safety for all configuration options. Installation This plugin is…
-
manifest.py
The plugin generates a Web App Manifest (manifest.json) file for your site. This enables Progressive Web App (PWA) features and provides metadata for mobile…
-
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…
-
generator.py
The plugin adds a meta generator tag to each generated HTML page, indicating that the page was generated by Markata and including the version number.…
-
base_cli.py
The plugin provides Markata's core command-line interface functionality, including essential commands like , , and . Installation This plugin is built-in…
-
sitemap.py
[DEPRECATED] The plugin is deprecated and will be removed in a future version. Please use instead, which provides more comprehensive sitemap generation…
-
auto_title.py
The plugin automatically generates titles for posts that don't have a title specified in their frontmatter. It uses the filename to create a human-readable…
-
create_models.py
The plugin dynamically creates Markata's core Pydantic models by combining model fragments from various plugins. This enables extensible and type-safe data…
-
create_covers.py
The plugin is a simplified version of the covers plugin. It generates basic cover images with titles using a single template and font configuration.…
-
tui.py
None
-
rss.py
[DEPRECATED] The plugin is deprecated and will be removed in a future version. Please use instead, which provides more comprehensive feed generation…
-
heading_link.py
The plugin adds clickable link icons next to headings in your HTML output. This makes it easy for readers to share direct links to specific sections of your…
-
render_markdown.py
The plugin converts markdown content to HTML. This plugin is essential for rendering markdown files loaded by the plugin. Installation This plugin is…
-
copy_assets.py
The plugin copies static assets (images, CSS, JavaScript, etc.) from your assets directory to the output directory during the build process. Installation…
-
__init__.py
None
-
runner.py
None !!! class Runner class ???+ source "Runner source " ```python class Runner: """Display Footer""" !!! method run method ???+ source "run source " !!!…
-
cli.py
None !!! function make_layout function ???+ source "make_layout source " ```python def make_layout() -> Layout: """Define the layout.""" layout =…
-
didyoumean.py
dummy didyoumean page for testing didyoumean suggestions
-
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 ( grid_attr`). grid_attr…
-
__main__.py
None
-
server.py
None !!! function find_port function ???+ source "find_port source " ```python def find_port(port: int = 8000) -> int: """Find a port not in ues starting at…
-
plugins.py
None
-
header.py
None !!! class Header class ???+ source "Header source " ```python class Header: """Display header with clock."""
-
__init__.py
None