v0.6.0

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).

ProTip: this was highly inspired by the
marksman-lsp by
artempyanykh which can autocomplete post
links in this style for you.

v0.5.3

Pinned textual<0.2.0 until breaking changes are resolved.

v0.5.2

0.5.2

• clean up unnecessary images_url is missing warning #104 0.5.2.dev1

v0.5.1

0.5.1

• fix: contrast ratio on admonitions was not sufficient for A11y #103 0.5.1.dev0

v0.5.0

0.5.0

• Create new cli command for creating new blogs, posts, and plugins #93
  0.5.0.dev16 base_cli-docs
• Remove unused function clif that was the original entrypoint #81 0.5.0.dev8
• Allow template variables to be used in head config #88 0.5.0.dev12
• Expose markata.__version__ to templates as __version__ #89 0.5.0.dev13
• Fix, ignore post_template save on posts without an html attribute #92 0.5.0.dev13
• Fix #33 sluggify paths #69 BREAKING CHANGE 0.5.0.dev6
• Configurable template #70 0.5.dev5, #85 0.5.0.dev11
• Fix #40 Images overlfow outside of body #66 0.5.0.dev3
• Created entrypoint hook allowing for users to extend marka with jinja
  exensions #60 0.5.0.dev2
• Moved to PEP 517 build #59 0.5.0.dev1
• new markata.plugins.redirects will create redirect html files as a backup when
  server-side redirects fail, or the user does not have the ability to issue. #76 0.5.0.dev10
  redirects-docs
• create a slugify migration script #82
• DeepMerge config_overrides with config in post render methods #91 0.5.0.dev13
• Create ipython extension to automatically load markata #79 0.5.0.dev15
• Fix: images wrapped in a link overflow outside of the body #96
• new markata.plugins.service_worker plugin to create service workers and
  enable offline mode on sites #94 0.5.0.dev15
  service-worker-docs
• Fix: icon's were relatively linked, and were broken for any page other than
  index, they are now absolutely linked to the root of the site. #97 0.5.0.dev16
• Fix: auto_descriptions were not rendered on first pass in tui or at all in
  build due to auto_description running after jinja_md. #100 0.5.0.dev18
• Fix: give redirect pages a uniqe description and title #101 0.5.0.dev19

new cli command

More information in the base_cli-docs.

# create a new blog template
# copier requires you to specify a directory
markata new blog [directory]

# create a new blog post
markata new post

# create a new plugin
markata new plugin

markata new --help

 Usage: markata new [OPTIONS] COMMAND [ARGS]...

 create new things from templates

╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                                                                                                       │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ blog       Create a new blog from using the template from https://github.com/WaylonWalker/markata-blog-starter.                                                                   │
│ plugin     Create a new plugin using the template at https://github.com/WaylonWalker/markata-plugin-template.                                                                     │
│ post       Create new blog post in the pages directory from the template at  https://github.com/WaylonWalker/markata-post-template.                                               │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

sluggify paths

python-sluggify was implemented to ensure good urls are in place despite the
name of the original file.

For examples of how python-slugify will change your url's see the
project's home page. One
difference is that markata will leave /'s for routing in the slugs.

OPTING OUT

do not want to use slugify, you can opt out by setting slugify=False in your
markata.toml.
If you have an existing site and do not want to implement redirects, or simply

[markata]
slugify=false

Migrating to slugify

From the command line with markata>=0.5.0 installed run the
migration script from the command line to create a redirects file in the
default location. This should avoid all 404's as it will create a redirects
file that many static hosting providers will issue a server-side 301 for, and
for those that don't, markata.plugins.redirects creates a redirect html page,
that will kick in as a backup.

python -m markata.scripts.migrate_to_slugify

configurable page template

Now injects seo into the default template through configuration. Here is an
example, by adding this to your markata.toml configuration.

[[markata.head.meta]]
name = "og:type"
content = "article"

[[markata.head.meta]]
name = "og:author"
content = "Waylon Walker"

[[markata.head.meta]]
name = "og:site_name"
content = "Waylon Walker"

[[markata.head.meta]]
name = "theme-color"
content="#322D39"

[[markata.head.meta]]
name = "twitter:creator"
content="@_waylonwalker"

You will end up with these meta tags in your html.

<meta name="og:type" content="article">
<meta name="og:author" content="Waylon Walker">
<meta name="og:site_name" content="Waylon Walker">
<meta name="theme-color" content="#322D39">
<meta name="twitter:creator" content="@_waylonwalker">

You can have an array of toml tables with a key of text. The text will be
added as plain text to the end of the head of each page.

[[markata.head]]
text = """
<style>
img {
width: 100%;
height: auto;
}
ul {
  display: flex;
  flex-wrap: wrap;
}

li {
  flex: 1 2 400px;
}
</style>

"""

Descriptions will now properly end up in each page.

  <meta name="description" content="{{ description }}">

Config Overrides

Each post can override config settings such as head. New meta tags can be
added to a single post, or anything that your template might reference from
config.

config_overrides:
  head:
    meta:
    - content: waylonwalker
      name: author
    - content: '@_waylonwalker'
      name: 'twitter:creator'
    link:
    - href: https://waylonwalker.com/that-special-post/
      rel: canonical
    text:
    - value: <link rel='stylesheet' href='/my-extra-styles.css' />

ipython extension

Markata has an ipython extension if you want ipython to automatically load with
an instance of Markata mapped to m and markata you can add the following
to your ~/.ipython/profile_default/ipython_config.py

c.InteractiveShellApp.extensions.append('markata')

v0.4.1

0.4.1

• Issue FutureWarning for upcoming change to slugify change that will change urls

To keep existing behavior add this to your markata.toml.

[markata]
slugify=false

v0.4.0

0.4.0

• feat: add html logging with setup_logging
  plugin is all new closes #37
• fix: remove HTML tidy as the site generator tag
• feat: create configurable navbar
• perf: prevent double runs on pre-render and post-render #39
• perf: prevent duplicate ruun from to_dict calling pre-render #53
  • to_dict only runs up to render phase if necessary as directed by register_attr
• perf: only prettify if configured #54
• fix: pyinstrument will not create a second profiler causing it to end in errors #50
• fix: sites without feeds config do not create an index #55

Double Runs

Previously markata would catch AttributeError and run the previous step any
time you ran a step too early. The way this was implemented caused some steps
such as pre-render and post-render to run twice with every single run.

This change will no longer catch attribute errors. If you run into any issues
with your plugins not running before asking for attributes created by your
plugin make sure that you implement the
@register_attr
decorator.

Prettify

prettify html has been turned off by default as beautifulsoup4 prettify was
taking a significant time, and was often popping up as the slowest parts in my
personal _profile. If you want to continue running prettify throughout the
build you can set a flag in your config to continue running prettify.

[markata]
prettify_html = true

v0.0.2

0.2.0

• feat: auto_description plugin is all new closes #13
• deprecated: long_description has been deprecated by auto_description
• fix: covers plugin which would previously skip every time.
• feat: markata clean cleans up your cache and output from the command line
• fix: publish_source plugin will now ignore any non yaml serializable values
• feat: Default template colors are now customizable
• feat: Default template now has light and dark theme
• feat: map now has the ability to map entire posts
• feat: prevnext plugin was added to link between posts closes #20
• feat: jinja_md plugins was added to incorporate jinja into all the markdown
• breaking: feeds config now has feeds and feeds_config
• feat: output_html can now be specified in the frontmatter see example
• feat: edit link is now included in the default page template closes #21

breaking change to feeds config

If you are using the 0.1.0 version of feeds, and have configured custom
templates in markata.feeds.template and markata.feeds.card_template they
will need to be moved to markata.feeds_config.

Here is what you need to do to update your feeds_config.

+ [markata.feeds_config]
+ template="pages/templates/archive_template.html"
+ card_template="plugins/feed_card_template.html"
- [markata.feeds]
- template="pages/templates/archive_template.html"
- card_template="plugins/feed_card_template.html"

markata.feeds will only be used to configure feeds pages.

map entire posts

post is now exposed to the markata.map object, allowing you to return a
list of posts.

m = Markata()
# 'post' will return the entire post
m.map('post', filter='"git" in tags')

Customizable colors

[markata]
# default dark theme
color_bg = '#1f2022'
color_bg_code = '#1f2022'
color_text = '#eefbfe'
color_link = '#47cbff' 
color_accent = '#e1bd00c9'
overlay_brightness = '.85'

# pink and purple
color_bg = 'deeppink'
color_bg_code = 'rebeccapurple'
color_text = 'white'
color_link = 'aqua' 
color_accent = 'peachpuff'
overlay_brightness = '1.2'

# default light theme
color_bg_light = '#eefbfe'
color_bg_code_light = '#eefbfe'
color_text_light = '#1f2022'
color_link_light = '#47cbff' 
color_accent_light = '#ffeb00'
overlay_brightness_light = '.95'

All New auto_description plugin

• Cache is busted on plugin change
• plugin is configurable
• plugin now has docs

auto_description Configuration

Open up your markata.toml file and add new entries for your
auto_descriptions. You can have multiple desriptions, each one will be named
after the key you give it in your config.

[markata]
hooks=[
   "markata.plugins.auto_description",
   ]

[markata.auto_description.description]
len=160
[markata.auto_description.long_description]
len=250
[markata.auto_description.super_description]
len=500

In the above we will end up with three different descritpions,
(description, long_description, and super_description) each will be the
first number of characters from the document as specified in the config.

auto_descriptions are no longer duplicated

4e299d6 fixes the dedupe issue that was in develop for awhile and closes #24

0.1.0

0.1.0

• fix: pyinstument plugin no longer overrides the main cli callback
• feat: default is to run the profiler if pyinstrument is installed
• fix: --profile is now under the build command
• feat: --pretty/--no-pretty will make pretty tracebacks, and skip over framework code (closes #4 )
• fix: links are now absolute so they work from github, thanks MR Destructive
• deprecate: article['content_hash'] has been removed with preference for simply hashing on article['content']
• create heading_link plugin
• doc: How to create your home page. https://markata.dev/home-page/ (closes #9)

New cli help

After the pyinstrument plugin was fixed --version and --to-json are back, and --profile is now under the build command.

New Heading Link Plugin

The new heading link plugin makes it easier to share the exact part of an article you want with someone, by giving clickable links to the id of the heading it's next to.

0.0.1

First release of Markata is here 🎉

This has been a work in progress for nearly a full year. It all started as a python developer (me) frustrated with using a completely different language system (nodejs) that wanted to learn how to build better plugin driven frameworks in python. I was using static site generators that were built in other languages and they worked great, until they didn't. Once they broke it was really hard to debug as I was not in that ecosystem on a regular basis.

Markata aims to allow python developers to build the sites they want by simply using the sane set of defaults out of the box, or disabling all of the defaults and writing their own suite of plugins.

Out of the box you should expect 100 lighthouse scores, very lightweight pages, and a simple feed to link them all together.

Full Changelog: https://github.com/WaylonWalker/markata/commits/v0.0.1