Skip to main content

Static site generator plugins all the way down.

Project description


Markata

Markdown to site, plugins all the way down

A static site generator that will give you a great site with many standard web features like rss, sitemaps, and seo tags, out of the box. Running markata build will get you a that only requires you to write Markdown. If you have additional features that you want, don't worry, since markata is built completely on plugins you can develop and install your own plugins to add the features you want.

This has been a pet project for me to learn library development, plugin driven design, diskcache, and more. It is the core of what builds my own site waylonwalker.com.

UPCOMING NEXT RELEASE

The next release will be jinja filled. Out with all the single file templates, template strings, looping through card generation, we will have a proper jinja env with includes, bases, and all the things. It will be much easier to maintain and render faster.

Disclaimer

Make sure that you pin down what version of markata you want to use. If you are starting a new project that's probably the latest version from pypi. Things are likely to change in major releases, I do my best to document them, and not to break patches.

QuickStart

Markata is fully configurable through a markata.toml file, but the defaults allow to build your site right out of the box with nothing more than Markdown.

Installation

markata is hosted on pypi and can be installed using pip.

python -m pip install markata

# or if pipx is your thing

pipx install markata

Building a Blog with Markata using a template

The markata cli includes a new command that will present you with questions to fill in the jinja variables in this repo.

markata new blog [directory]

markata build
# start the site and watch for changes
markata serve

Now if you open localhost:8000, you will be presented with an example site that will walk you through some features of markata. You can play with it at your own pace, or drop all the pages and start writing your own content.

new blog gif

Motivation

Markata is able to build your site purely from Markdown, allowing you to get started creating your own content quickly. Out of the box it will cover your seo tags, rss feeds, sitemap, and og images. Since it is built completely from plugins you can remove, modify, or add to any of its behavior.

  • configurable
  • plugins
  • seo
  • rss
  • sitemap
  • og-image

Using Markata

The docs are still a work in progress, but the base_cli walks through how to effectively use the markata build command. At this point Markata is far from stable and will change quite a bit, should you choose to use it on real site make sure you pin to the version that you want to build from. I will let you know as it becomes more stable and ready to use without diligence of pinning to the version you want.

Honestly A big motivation for me was wanting to learn and understand how to create a project that is completely plugin driven. This is highly a learning project for me, and it has grown into something I use every day.

Examples Gallary

Markata has a project gallery to show off sites built with markata. Please submit yours, and check out the project-gallery for inspiration.

Project details


Release history Release notifications | RSS feed

This version

0.9.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markata-0.9.1.tar.gz (15.9 MB view details)

Uploaded Source

Built Distribution

markata-0.9.1-py3-none-any.whl (203.7 kB view details)

Uploaded Python 3

File details

Details for the file markata-0.9.1.tar.gz.

File metadata

  • Download URL: markata-0.9.1.tar.gz
  • Upload date:
  • Size: 15.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for markata-0.9.1.tar.gz
Algorithm Hash digest
SHA256 a01dc1bb3e00f6e7b7e666a819895af3dc71a1b208cc544518a36dc20c3079af
MD5 063245e1092e83f47de919f339f8dfb6
BLAKE2b-256 d7b9b94aa066453b71d3541cf11e72daee0151d0349ec93f0bac0fb26b31025a

See more details on using hashes here.

File details

Details for the file markata-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: markata-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 203.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for markata-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d3c1407f00f9b0549064d08b10b98a7314bf62eceddba7c1cd207aaae648e647
MD5 d36e828d4a28aea65ff7840269d7f2bb
BLAKE2b-256 0a7aee55140db7e278280e33d72a51ba0a1577583bfe6386a74ca9efb5a19d78

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page