Skip to content

Commit

Permalink
docs: fix mkdocs docs gen
Browse files Browse the repository at this point in the history
  • Loading branch information
phil65 committed Oct 24, 2024
1 parent 09f817b commit 1b6d680
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 55 deletions.
110 changes: 55 additions & 55 deletions configs/mkdocs_mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,58 +5,58 @@ site_description: A MkDocs page created by MkNodes
repo_url: "https://github.com/mkdocs/mkdocs/"
site_url: https://phil65.github.io/mknodes/mkdocs/
plugins:
- mknodes:
repo_path: https://github.com/mkdocs/mkdocs.git
clone_depth: 100
build_fn: mknodes:parse
kwargs:
pages:
- title: Home
type: MkText
text: "{{ metadata.description }}"
is_index: true
- Usage:
- type: MkTemplate
title: Getting started
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/getting-started.md
- type: MkTemplate
title: Configuration
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/user-guide/configuration.md
- type: MkTemplate
title: Deploying your docs
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/user-guide/deploying-your-docs.md
- type: MkTemplate
title: Installation
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/user-guide/installation.md
- title: API
type: MkDoc
section_name: "API"
recursive: true
- title: CLI
type: MkCliDoc
show_subcommands: true
condition: "{{ metadata.cli }}"
- Development:
- title: Changelog
type: MkChangelog
- title: Code of Conduct
type: MkCodeOfConduct
- title: Contributing
type: MkCommitConventions
- title: Pull requests
type: MkPullRequestGuidelines
- title: Dependencies
type: MkPage
items:
- title: Dependency table
type: MkDependencyTable
- title: Dependency tree
type: MkPipDepTree
direction: LR
- title: Dependencies
type: MkDependencyTable
- title: MkDocs Plugins
condition: '{{ "mkdocs.plugins" in metadata.entry_points }}'
type: MkPluginFlow
- title: License
type: MkLicense
- mknodes:
repo_path: https://github.com/mkdocs/mkdocs.git
clone_depth: 100
build_fn: mkdocs_mknodes:parse
kwargs:
pages:
- title: Home
type: MkText
text: "{{ metadata.description }}"
is_index: true
- Usage:
- type: MkTemplate
title: Getting started
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/getting-started.md
- type: MkTemplate
title: Configuration
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/user-guide/configuration.md
- type: MkTemplate
title: Deploying your docs
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/user-guide/deploying-your-docs.md
- type: MkTemplate
title: Installation
template: https://raw.githubusercontent.com/mkdocs/mkdocs/master/docs/user-guide/installation.md
- title: API
type: MkDoc
section_name: "API"
recursive: true
- title: CLI
type: MkCliDoc
show_subcommands: true
condition: "{{ metadata.cli }}"
- Development:
- title: Changelog
type: MkChangelog
- title: Code of Conduct
type: MkCodeOfConduct
- title: Contributing
type: MkCommitConventions
- title: Pull requests
type: MkPullRequestGuidelines
- title: Dependencies
type: MkPage
items:
- title: Dependency table
type: MkDependencyTable
- title: Dependency tree
type: MkPipDepTree
direction: LR
- title: Dependencies
type: MkDependencyTable
- title: MkDocs Plugins
condition: '{{ "mkdocs.plugins" in metadata.entry_points }}'
type: MkPluginFlow
- title: License
type: MkLicense
8 changes: 8 additions & 0 deletions mkdocs_mknodes/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,12 @@

telemetry.setup_logfire()


def parse(root, theme, pages):
from mknodes.navs.navparser import parse_new_style_nav

parse_new_style_nav(root, pages)
return root


__all__ = ["MkDefaultWebsite"]

0 comments on commit 1b6d680

Please sign in to comment.