Changelog¶

check pydocstyle toml section for docstring style (d4b102d by phil65).
add CLI info to context (80d532f by phil65).
automatically add pipx as package repo for console_scripts packages (59b88a7 by phil65).
support fsspec protocol URLs in from_url (a3154fb by phil65).

Bug Fixes¶

correct handling of some paths for JinjaLoaderFileSystem (d9d67ed by phil65).

v0.45.4 - 2023-10-21¶

Compare with v0.45.3

Bug Fixes¶

use regular icon format in config to prevent build issue with social plugin (0d3c7f7 by phil65).

v0.45.3 - 2023-10-21¶

Compare with v0.45.2

Features¶

fsspec support for MkPage.from_file (26f6d49 by phil65).
support for fsspec paths (1cc4beb by phil65).
add FsSpec jinja loaders (b378ae5 by phil65).

Bug Fixes¶

typo in ImageSlideshow script (b963010 by phil65).

v0.45.2 - 2023-10-20¶

Compare with v0.45.1

Features¶

edit_url property (6e3954d by phil65).

Code Refactoring¶

make status_icons a mapping (b1220f3 by phil65).

v0.45.1 - 2023-10-19¶

Compare with v0.45.0

Features¶

allow using iconify slugs (180e2fc by phil65).
add tooltip option (6d075be by phil65).
allow tuple in ctor (4fcdb2e by phil65).

Bug Fixes¶

some attr_list fixes (b62c78e by phil65).
attr_list for MkAdmonition (9f13bed by phil65).

v0.45.0 - 2023-10-19¶

Compare with v0.44.8

Features¶

option to return multiple svgs in one get_icon_svg call (b7af76a by phil65).
add MkJinjaText (6622e0a by phil65).
some more helpers for the environment (7182f26 by phil65).
allow multiple files for INHERIT (fae80ca by phil65).

Bug Fixes¶

no a tag if no link given (33e3e43 by phil65).
fix for non-project-package CLIs (602010c by phil65).
correctly attach css classes (250b7ef by phil65).

v0.44.8 - 2023-10-18¶

Compare with v0.44.7

Bug Fixes¶

Router condition fix (28cc40f by phil65).

v0.44.7 - 2023-10-18¶

Compare with v0.44.6

v0.44.6 - 2023-10-18¶

Compare with v0.44.5

Features¶

add condition kwarg to Router.route_page / route_nav (78f49c4 by phil65).

Bug Fixes¶

drop build stats for eq check (ed09c14 by phil65).

v0.44.5 - 2023-10-18¶

Compare with v0.44.4

Bug Fixes¶

only access env prop once (70810c2 by phil65).

v0.44.4 - 2023-10-18¶

Compare with v0.44.3

Features¶

allow toml path in MkTimeline ctor (d6e9628 by phil65).

v0.44.3 - 2023-10-18¶

Compare with v0.44.2

Features¶

allow populating MkDocs-Material alternate selector (bfc20e4 by phil65).
support str for plugin in ctor (2aaa700 by phil65).
add MkCompactAdmonition (fbe9cf8 by phil65).

Bug Fixes¶

color fix for custom admonitions (2bd3536 by phil65).
correctly map icon sets (8992796 by phil65).

v0.44.2 - 2023-10-17¶

Compare with v0.44.1

Bug Fixes¶

fix icon path adjustment in Metadata ctor (b5863a7 by phil65).

v0.44.1 - 2023-10-17¶

Compare with v0.44.0

Features¶

add get_icon_svgto env filters (051cc2d by phil65).
add creation / revision date to metadata (c3597b8 by phil65).

v0.44.0 - 2023-10-17¶

Compare with v0.43.17

Features¶

description for StatusIcon (0134b71 by phil65).

Bug Fixes¶

Correct nesting for routed pages (ce0471c by phil65).

Code Refactoring¶

streamline MkPage.metadata (c174603 by phil65).

v0.43.17 - 2023-10-17¶

Compare with v0.43.16

Features¶

add MkIcon (9757ef6 by phil65).

Bug Fixes¶

status icon css fix (5f1e373 by phil65).

Code Refactoring¶

set custom emoji index in get_resources (1ff0268 by phil65).

v0.43.16 - 2023-10-16¶

Compare with v0.43.15

Bug Fixes¶

Fix visual glitch for MkTimeline (d793b6f by phil65).

v0.43.15 - 2023-10-16¶

Compare with v0.43.14

Bug Fixes¶

correct griffe module as env global for top-level modules (c7a9ea4 by phil65).

Code Refactoring¶

add griffe registry (1181120 by phil65).

v0.43.14 - 2023-10-16¶

Compare with v0.43.13

Features¶

provide index with pyconify icons for emoji extension (d554824 by phil65).

Bug Fixes¶

fix resolve_inherit_tag method (0bd8140 by phil65).

v0.43.13 - 2023-10-15¶

Compare with v0.43.12

v0.43.12 - 2023-10-15¶

Compare with v0.43.11

Bug Fixes¶

include eventlistener script (2bd2070 by phil65).

Code Refactoring¶

rework index page integration (1361ecb by phil65).
allow "title-less" MkPages for routing (1b9a459 by phil65).

v0.43.11 - 2023-10-12¶

Compare with v0.43.10

Bug Fixes¶

dont rely on typer/click being installed (5d2bfe6 by phil65).

v0.43.10 - 2023-10-12¶

Compare with v0.43.9

Bug Fixes¶

transfer attributes when resolving js script (ad35973 by phil65).
correct status icon name for MaterialTheme (e806a82 by phil65).

Code Refactoring¶

use template for MkCommitConventions (2a3c816 by phil65).

v0.43.9 - 2023-10-09¶

Compare with v0.43.8

Bug Fixes¶

slugify MkPage path (b17feaa by phil65).

v0.43.8 - 2023-10-03¶

Compare with v0.43.7

Bug Fixes¶

add missing "version" badge (32c4e03 by phil65).

v0.43.7 - 2023-10-02¶

Compare with v0.43.6

v0.43.6 - 2023-10-01¶

Compare with v0.43.5

Bug Fixes¶

CSS colors for some color themes were hard to read (e9d3ed0 by phil65).

v0.43.5 - 2023-10-01¶

Compare with v0.43.4

Features¶

allow setting non-root homepage (ac4ed28 by phil65).

v0.43.4 - 2023-10-01¶

Compare with v0.43.3

Features¶

add method to add new FileSystemLoaders during runtime (86004cd by phil65).

v0.43.3 - 2023-10-01¶

Compare with v0.43.2

Bug Fixes¶

make sure to populate env before calling build fn (4bfb434 by phil65).
make sure to pass hashable types to cache fn (1858142 by phil65).

Code Refactoring¶

no Material-specific CSS for all nodes (cbbeded by phil65).

v0.43.2 - 2023-09-30¶

Compare with v0.43.1

Bug Fixes¶

make resources hashable (c04d0e7 by phil65).

v0.43.1 - 2023-09-30¶

Compare with v0.43.0

Features¶

render css as jinja template (691ee23 by phil65).

v0.43.0 - 2023-09-30¶

Compare with v0.42.3

v0.42.3 - 2023-09-30¶

Compare with v0.42.2

v0.42.2 - 2023-09-30¶

Compare with v0.42.1

Code Refactoring¶

rename Requirements to Resources (d8c86ef by phil65).

v0.42.1 - 2023-09-30¶

Compare with v0.42.0

v0.42.0 - 2023-09-30¶

Compare with v0.41.1

Features¶

add MkMaterialBadge (5c98926 by phil65).
allow setting css for specific pages (d3a3eb8 by phil65).

Bug Fixes¶

fix material color theme css (654049c by phil65).
fix reducing extension list for MdConverter (31fd1ad by phil65).

Code Refactoring¶

BuildCollector manages the backends now (d311b67 by phil65).

v0.41.1 - 2023-09-29¶

Compare with v0.41.0

Bug Fixes¶

fix adapting extensions to theme (fcd1663 by phil65).

v0.41.0 - 2023-09-28¶

Compare with v0.40.0

Features¶

MkJinjaTemplate now returns the rendered MkNodes as its children (1760603 by phil65).
MkHeader support for LinkProvider (9b4630b by phil65).
allow index.py files instead of SUMMARY.md (5bd5f78 by phil65).
Custom admonitions for base MkDocs theme (e147451 by phil65).
allow setting header text color for custom admonitions (fa3a278 by phil65).
template propagation from navs to pages (5bed3f5 by phil65).
add node.as_html attr (0647ac0 by Philipp Temminghoff).
add get_url and get_link filters to Jinja env (eccc02a by Philipp Temminghoff).

Bug Fixes¶

pass variables to render call for MkJinjaTemplate (ee4be09 by phil65).
missing whitespace before attr_list term (1c82bd2 by Philipp Temminghoff).
Use PackageLoader instead of FileSystemLoader (9171f38 by Philipp Temminghoff).
Page templates inherit from main instead of base (d8dfa46 by Philipp Temminghoff).

Code Refactoring¶

collect rendered MkNodes (a793e5b by Philipp Temminghoff).

v0.40.0 - 2023-09-22¶

Compare with v0.39.0

Features¶

quick access to individual templates for each page (432ae0e by Philipp Temminghoff).
add MkTimeline (af15a71 by Philipp Temminghoff).
generate our own CLI docs for Click / Typer (1131d83 by Philipp Temminghoff).
add MkImageCompare and MkImageSlideshow (7c53207 by Philipp Temminghoff).

Bug Fixes¶

also delete per-page-templates on cleanup (768f3a2 by Philipp Temminghoff).
show correct badges when package is set explicitely (165c5d6 by Philipp Temminghoff).
correct page edit URI (0a8b188 by Philipp Temminghoff).
prefer page title over path for the menu (5feaf4e by Philipp Temminghoff).
fixed Config output for some tools (8f81719 by Philipp Temminghoff).

Code Refactoring¶

get rid of cssclasses dep (644ede4 by Philipp Temminghoff).

v0.39.0 - 2023-09-19¶

Compare with v0.38.0

Features¶

MkPage metadata now merges in MkNav metadata (like the meta plugin) (e399b2c by Philipp Temminghoff).

Code Refactoring¶

get rid of show_source kwarg for decorators (694f9cd by Philipp Temminghoff).
make env part of context (5176c2c by Philipp Temminghoff).

v0.38.0 - 2023-09-17¶

Compare with v0.37.0

Features¶

allow passing a base_path for NavParser.json (ae8fcbd by Philipp Temminghoff).
metadata: use mkdocs util in order to also support MultiMarkdown style (afe2371 by Philipp Temminghoff).
add MkPipDepTree (36f2708 by Philipp Temminghoff).
add MkContainer.in_html_tag contextmanager (c28e6d6 by Philipp Temminghoff).

Bug Fixes¶

correct linking to MkNavs (de24837 by Philipp Temminghoff).

Code Refactoring¶

completely rework TemplatePages, jinja-based now (5b66f38 by Philipp Temminghoff).
move all parse stuff to NavParser (314e0c9 by Philipp Temminghoff).

v0.37.0 - 2023-09-15¶

Compare with v0.36.0

Features¶

also support strings as input (53c0c4c by Philipp Temminghoff).
add MkBinaryImage.for_file (6cd412b by Philipp Temminghoff).
add source button to action buttons (17b0a22 by Philipp Temminghoff).
add MkNode registry (069f7c9 by Philipp Temminghoff).
auto-set syntax based on file extension (144ca63 by Philipp Temminghoff).

Bug Fixes¶

pass kwargs to parent (a831984 by Philipp Temminghoff).

Code Refactoring¶

shortcut for material/ icons refactor: improved routing decorator system (074a5c8 by Philipp Temminghoff).
move stuff to backend (d6210b8 by Philipp Temminghoff).
allow git url in FolderInfo ctor (d6ed22a by Philipp Temminghoff).
split up build backends (f389d16 by Philipp Temminghoff).
add PackageRegistry (cf2164a by Philipp Temminghoff).

v0.36.0 - 2023-09-12¶

Compare with v0.35.2

Features¶

add support for ->MkNode in SUMMARY.mds (92bf63b by Philipp Temminghoff).
allow defining MkNodes in mkdocs.yml (cde2f5e by Philipp Temminghoff).
add Github info to context (8f77c1b by Philipp Temminghoff).
DocString style for PackageContext (a2f23c9 by Philipp Temminghoff).

Bug Fixes¶

dont fail when config nav is manually populated (f77b87c by Philipp Temminghoff).

Code Refactoring¶

skip some mkdocs event hooks if no build fn is set (4104cfb by Philipp Temminghoff).
separate class for MkDocsConfigFile (d12ae2f by Philipp Temminghoff).

v0.35.2 - 2023-09-11¶

Compare with v0.35.1

Bug Fixes¶

protect against git exceptions (064198a by Philipp Temminghoff).

v0.35.1 - 2023-09-11¶

Compare with v0.35.0

Bug Fixes¶

use correct serializer (60185c8 by Philipp Temminghoff).

Code Refactoring¶

move nav stuff to navs module (5769e9b by Philipp Temminghoff).

v0.35.0 - 2023-09-10¶

Compare with v0.34.4

Features¶

allow urls in for_file (57c0603 by Philipp Temminghoff).
allow passing kwargs to build fn (b05501d by Philipp Temminghoff).
add MkPyDeps (84d602b by Philipp Temminghoff).
use rich-click for cli (55ffb1f by Philipp Temminghoff).
add MkCodeImage (4597305 by Philipp Temminghoff).
add cli create-config command (ee9b358 by Philipp Temminghoff).
show config admonition for tools (c496c6a by Philipp Temminghoff).

Bug Fixes¶

dont error out when pyproject name is missing (28e33ea by Philipp Temminghoff).
fix MkClickDoc (06cf0e6 by Philipp Temminghoff).
unique name for entry points (1d45a23 by Philipp Temminghoff).
allow modules as entry points (378df6b by Philipp Temminghoff).
prevent double entries in registry (c2ec08b by Philipp Temminghoff).
fix mknodes build cmd (53abfc2 by Philipp Temminghoff).

Code Refactoring¶

add linkprovider to context (03eadcc by Philipp Temminghoff).
switch to typer (d8fdfe1 by Philipp Temminghoff).
get rid of infocollector (9af2738 by Philipp Temminghoff).
one global env for all nodes (60362c4 by Philipp Temminghoff).
use deepmerge instead of mergedeep (354fcce by Philipp Temminghoff).
allow custom licenses (83dfd70 by Philipp Temminghoff).
cache badges (0719cc1 by Philipp Temminghoff).

v0.34.4 - 2023-09-06¶

Compare with v0.34.3

Bug Fixes¶

CLI fixes (2b08e02 by Philipp Temminghoff).

v0.34.3 - 2023-09-06¶

Compare with v0.34.2

Features¶

list all available plugins (64643ee by Philipp Temminghoff).

Bug Fixes¶

hide MkDocStrings-related nested header for MkPluginFlow (e552d23 by Philipp Temminghoff).

v0.34.2 - 2023-09-06¶

Compare with v0.34.1

Bug Fixes¶

suppress yaml exceptions (in case python object loading fails) (226bd05 by Philipp Temminghoff).

v0.34.1 - 2023-09-06¶

Compare with v0.34.0

Bug Fixes¶

linting fix (063ed3a by Philipp Temminghoff).

v0.34.0 - 2023-09-06¶

Compare with v0.33.0

Features¶

add Project.for_path (099df7b by Philipp Temminghoff).
auto-choose mkdocs-typer if typer is installed (ed3e59f by Philipp Temminghoff).
add verbose option (de85dcc by Philipp Temminghoff).
add clone_depth config option (84c56a6 by Philipp Temminghoff).
add MkClickDoc (a81133e by Philipp Temminghoff).
add get_install_candidates method (d2bc3d1 by Philipp Temminghoff).
start with CLI module (bac5c0c by Philipp Temminghoff).
add hook info admonition (f5ac7f5 by Philipp Temminghoff).

Bug Fixes¶

pass config to MaterialTheme (6151d6c by Philipp Temminghoff).

Code Refactoring¶

hide source admonition for MkPluginFlow hook info (a776c9a by Philipp Temminghoff).

v0.33.0 - 2023-09-04¶

Compare with v0.32.0

Features¶

allow setting custom fence level (70e894d by Philipp Temminghoff).
add MkWebsite (c2af1d8 by Philipp Temminghoff).
set social extra if not existing (cc1c90f by Philipp Temminghoff).
allow using remote repositories as infoprovider (d1317a7 by Philipp Temminghoff).
allow excluding section from search (1b37615 by Philipp Temminghoff).

Bug Fixes¶

fix license file path (9b8f13e by Philipp Temminghoff).
use mergedeep for adding extension configs (910c2bf by Philipp Temminghoff).
fix incorrect downloads badge (0516ecd by Philipp Temminghoff).
dont error out if no plugin exists (e9b07e7 by Philipp Temminghoff).

Code Refactoring¶

dont require to set module for project (be06df3 by Philipp Temminghoff).

v0.32.0 - 2023-09-01¶

Compare with v0.31.0

Features¶

add MkTaskList (079276d by Philipp Temminghoff).
add MkArgParseHelp (00d45cb by Philipp Temminghoff).

Bug Fixes¶

only override metadata if set in from_file (bf212ab by Philipp Temminghoff).
only convert to header if text contains no linebreaks (010ec36 by Philipp Temminghoff).
dont touch SUMMARY.mds (f274f6a by Philipp Temminghoff).

Code Refactoring¶

switch to new-style plugin config (1664029 by Philipp Temminghoff).
use decorators for dev section (06ee093 by Philipp Temminghoff).
more linking rework (6b21b4d by Philipp Temminghoff).
rework page linking (13c2d6f by Philipp Temminghoff).
cleanup link replacer (da3b633 by Philipp Temminghoff).

v0.31.0 - 2023-08-29¶

Compare with first commit

Features¶

optional icon for tree repr (fd6cb6f by Philipp Temminghoff).
add Badge layout for MkDependencyTable (5549979 by Philipp Temminghoff).

Bug Fixes¶

fix bug in Metadata.parse (e6beb65 by Philipp Temminghoff).

Code Refactoring¶

dont rely on cwd in MkNav.from_file (0341b71 by Philipp Temminghoff).
new style for MkCommandOutput (70500cf by Philipp Temminghoff).

Page info

Code for this page

mknodes.manual.get_started_section._
@nav.route.page("Changelog", icon="format-list-group")
def _(page: mk.MkPage):
    page += mk.MkChangelog()

Resources

Resources(css=[],
          markdown_extensions={'attr_list': {},
                               'md_in_html': {},
                               'pymdownx.emoji': {'emoji_generator': <function to_svg at 0x7fd7a6931800>,
                                                  'emoji_index': <function twemoji at 0x7fd7a69316c0>},
                               'pymdownx.magiclink': {'repo': 'mknodes',
                                                      'repo_url_shorthand': True,
                                                      'user': 'phil65'}},
          plugins=[],
          js=[],
          assets=[],
          packages=[])

Metadata

created:
  source_filename: /home/runner/work/mknodes/mknodes/mknodes/manual/get_started_section.py
  source_function: null
  source_line_no: 37
icon: material/format-list-group
template: SUMMARY.html
title: Changelog