About-the-project nodes

Node Docstrings Markdown extensions
MkChangelog Node for a git-based changelog (created by git-changelog).

!!! note
For building a changelog with Github Actions, the actions/checkout@v4
action needs to have fetch-depth set to 0 (or some other value.)
MkCodeOfConduct Node for a code of conduct section.
MkLicense Node to show a license.

If not explicitely set, the license will be pulled from the project.

MkDependencyTable Node for a table showing dependencies for a package. tables
MkInstallGuide Node to display an install guide.
MkCommitConventions Text node containing Commit message conventions.
MkPullRequestGuidelines Node showing pull request guidelines.
MkDevEnvSetup Text node containing Instructions to set up a dev environment.
MkDevTools Node showing information about used dev tools.
MkShields Container for Shields.io / GitHub badges.
MkMetadataBadges Container node for a list of metadata badges.

Badges are generated locally using "anybadge" package
:mdi-dependency: MkPipDepTree Node to display a mermaid diagram for the dependencies. pymdownx.superfences
MkPyDeps Node for showing a Dependency graph.
Page info
Code for this section
mknodes.manual.nodes_section._
@nav.route.nav("About-the-project nodes")
def _(nav: mk.MkNav):
    page = nav.add_page(is_index=True, hide="toc")
    page += create_section_for_nodes(nav, ABOUT_THE_PROJECT_NODES)
    page.created_by = create_section_for_nodes
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'},
                               'tables': {}},
          plugins=[],
          js=[],
          assets=[],
          packages=[])
Metadata
created:
  source_filename: /home/runner/work/mknodes/mknodes/mknodes/manual/nodes_section.py
  source_function: _
  source_line_no: 159
hide:
- toc
template: SUMMARY.html
title: About-the-project nodes