Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release 0.2.0 #35

Merged
merged 1 commit into from
May 23, 2022
Merged

release 0.2.0 #35

merged 1 commit into from
May 23, 2022

Conversation

WaylonWalker
Copy link
Owner

@WaylonWalker WaylonWalker commented May 23, 2022

0.2.0

  • feat: auto_description plugin is all new closes descriptions have new lines in them #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 Auto Linker plugin #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 Edit on GitHub #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

… is all new closes #13

* deprecated: long_description has been deprecated by auto_description
* fix: [covers](/markata/plugins/covers/) plugin which would previously skip every time.
* feat: [`markata clean`](/markata/plugins/base_cli/#clean-function) cleans up your cache and output from the command line
* fix: [`publish_source`](/markata/plugins/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](/markata/plugins/prevnext/) plugin was added to link between posts closes #20
* feat: [jinja_md](/markata/plugins/jinja_md/) plugins was added to incorporate jinja into all the markdown
* breaking: [feeds](/markata/plugins/feeds) config now has feeds and feeds_config
* feat: `output_html` can now be specified in the frontmatter [see example](/markata/plugins/publish_html/#explicityly-set-the-output)
* feat: edit link is now included in the default page template closes #21

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.

``` diff
+ [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.

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

``` python
m = Markata()
m.map('post', filter='"git" in tags')
```

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

color_bg = 'deeppink'
color_bg_code = 'rebeccapurple'
color_text = 'white'
color_link = 'aqua'
color_accent = 'peachpuff'
overlay_brightness = '1.2'

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'
```

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

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.

``` toml
[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.

4e299d6 fixes the dedupe issue that was in develop for awhile and closes #24
@WaylonWalker WaylonWalker merged commit ed3ffb4 into main May 23, 2022
@WaylonWalker WaylonWalker deleted the release-0.2.0 branch October 4, 2022 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant