Skip to content

Commit 39e2b95

Browse files
docs: update api reference
1 parent 6a3c4fd commit 39e2b95

12 files changed

Lines changed: 169 additions & 7 deletions

File tree

docs/.nav.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ nav:
1919

2020
- API Reference:
2121
- references/index.md
22+
- Frontend or Entry Point:
23+
- Command Line Interface: references/cli-api.md
24+
- Plugin Core: references/core-api.md
25+
- Independent Modules:
26+
- Plugin Configuration Module: references/config-api.md
27+
- Network Graph Visualization Module: references/graph-api.md
28+
- Utils Layers: references/utils-layers.md
2229

2330
- About:
2431
- Changelog: about/changelog.md

docs/contributing/contributing.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ First off, thank you for considering contributing to MkDocs Note! It's people li
1313

1414
There are many ways to contribute, from writing documentation and tutorials to reporting bugs and submitting code changes.
1515

16+
For developers, you'd better to read [Architecture Overview](architecture.md) first in order to understand the project framework and design philosophy.
17+
18+
For more details of plugin's api, you can refer to [API References](../references/index.md).
19+
1620
### Reporting Bugs
1721

1822
If you find a bug, please open an issue and provide the following information:

docs/references/cli-api.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
date: 2025-11-05 21:28:00
3+
title: CLI API
4+
permalink:
5+
publish: true
6+
---
7+
8+
# CLI API
9+
10+
This section is about the entry point of the [Command Line Interface (CLI)](../usage/cli.md) of the plugin that plays the role to handle CLI front-end calls.
11+
12+
## ::: mkdocs_note.cli

docs/references/config-api.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
date: 2025-11-05 21:55:37
3+
title: Plugin Configuration Module
4+
permalink:
5+
publish: true
6+
---
7+
8+
# Plugin Configuration Module
9+
10+
This section is about the module that plays the role to handle the plugin configuration which independent from the [plugin core](config-api.md).
11+
12+
It will be called by [plugin core](core-api.md) and [CLI](cli-api.md) directly.
13+
14+
## ::: mkdocs_note.config

docs/references/core-api.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
date: 2025-11-05 21:42:47
3+
title: Plugin Core
4+
permalink:
5+
publish: true
6+
---
7+
8+
# Plugin Core
9+
10+
This section is about the frontend/entry point of the plugin that plays the role to handle some page related operations.
11+
12+
## ::: mkdocs_note.plugin

docs/references/graph-api.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
date: 2025-11-05 22:00:32
3+
title: Graph Visualization Module
4+
permalink:
5+
publish: true
6+
---
7+
8+
# Graph Visualization Module
9+
10+
This section was the underlying module of the [network graph visualization](../usage/network-graph.md) feature which migrated from [MkDocs Network Graph Plugin](https://github.com/develmusa/mkdocs-network-graph-plugin).
11+
12+
It will be called by [plugin core](core-api.md) directly.
13+
14+
## ::: mkdocs_note.graph

docs/references/index.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
11
---
2-
date: 2025-10-16 14:25:41
2+
date: 2025-11-05 21:25:00
33
title: API References
44
permalink:
5-
publish: false
5+
publish: true
66
---
77

88
# API References
99

10-
Start writing your note content...
10+
This section is generated by [mkdocstrings](https://mkdocstrings.github.io/) and contains the API references for the `mkdocs-note` plugin.
11+
12+
According to the plugin's architecture, the main API of this project are divided into the following sections:
13+
14+
- Frontend or Entry Point
15+
16+
- <a href="core-api">Plugin Core</a>
17+
18+
- <a href="cli-api">CLI</a>
19+
20+
- Independent Modules
21+
22+
- <a href="config-api">Plugin Configuration</a>
23+
24+
- <a href="graph-api">Graph Visualization</a>
25+
26+
- Utils Layers
27+
28+
- <a href="utils-layers">Utils Layers</a>

docs/references/utils-layers.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
date: 2025-11-05 22:06:28
3+
title: Utils Layers
4+
permalink:
5+
publish: true
6+
---
7+
8+
# Utils Layers
9+
10+
This section is about the underlying utility functions that are used in the plugin, will be called by [plugin core](core-api.md) and [CLI](cli-api.md) directly.
11+
12+
And specifically, the `common` module of [CLI](cli-api.md) will call [plugin core](config-api.md) to get the plugin configuration instance, and `scanner` module will call `meta` module to validate the note file's frontmatter.
13+
14+
## ::: mkdocs_note.utils.meta
15+
16+
## ::: mkdocs_note.utils.scanner
17+
18+
## ::: mkdocs_note.utils.cli

docs/usage/asset-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ publish: true
77

88
# Asset Management
99

10-
The plugin automatically manages assets for each note using a **co-located structure**:
10+
The plugin automatically manages assets for each note using a **co-located structure** by its [CLI](cli.md):
1111

1212
## Co-Located Asset Organization
1313

mkdocs.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,16 @@ plugins:
112112
recent_notes_config:
113113
enabled: true
114114
insert_marker: "<!-- recent_notes -->"
115-
insert_num: 5
115+
insert_num: 10
116116
graph_config:
117117
enabled: true
118118
name: "title"
119119
debug: false
120-
# - redirects:
121-
# redirect_maps:
120+
- mkdocstrings:
121+
handlers:
122+
python:
123+
options:
124+
show_submodules: true
122125

123126
# extra_css:
124127

0 commit comments

Comments
 (0)