mkdocs-mknodes 0.0.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mkdocs_mknodes/__init__.py +1 -0
- mkdocs_mknodes/buildcollector.py +167 -0
- mkdocs_mknodes/cli/__init__.py +194 -0
- mkdocs_mknodes/manual/__init__.py +13 -0
- mkdocs_mknodes/manual/cli_section.py +37 -0
- mkdocs_mknodes/manual/dev_section.py +70 -0
- mkdocs_mknodes/manual/github_index.py +17 -0
- mkdocs_mknodes/manual/internals_section.py +74 -0
- mkdocs_mknodes/manual/multi_project.py +19 -0
- mkdocs_mknodes/manual/root.py +77 -0
- mkdocs_mknodes/manual/use_cases_section.py +34 -0
- mkdocs_mknodes/mkdocsconfig.py +141 -0
- mkdocs_mknodes/paths.py +11 -0
- mkdocs_mknodes/plugin/__init__.py +179 -0
- mkdocs_mknodes/plugin/build_page.py +165 -0
- mkdocs_mknodes/plugin/buildbackend.py +45 -0
- mkdocs_mknodes/plugin/linkreplacer.py +49 -0
- mkdocs_mknodes/plugin/markdownbackend.py +37 -0
- mkdocs_mknodes/plugin/mkdocsbackend.py +184 -0
- mkdocs_mknodes/plugin/mkdocsbuilder.py +127 -0
- mkdocs_mknodes/plugin/mkdocshelpers.py +24 -0
- mkdocs_mknodes/plugin/pluginconfig.py +45 -0
- mkdocs_mknodes/plugin/serve.py +228 -0
- mkdocs_mknodes/resources/build_process.jinja +55 -0
- mkdocs_mknodes/resources/cli_index.jinja +15 -0
- mkdocs_mknodes/resources/material_css.jinja +88 -0
- mkdocs_mknodes/resources/material_css_extra.jinja +223 -0
- mkdocs_mknodes/resources/mkclasspage.jinja +11 -0
- mkdocs_mknodes/resources/mkdocs_css.jinja +7 -0
- mkdocs_mknodes/resources/modulepage.md +11 -0
- mkdocs_mknodes/resources/python_objects.inv +0 -0
- mkdocs_mknodes/resources/requirements.md +31 -0
- mkdocs_mknodes/resources/use_case_by_config.jinja +10 -0
- mkdocs_mknodes/resources/use_case_default_website.jinja +10 -0
- mkdocs_mknodes/resources/use_cases_index.jinja +46 -0
- mkdocs_mknodes-0.0.2.dist-info/METADATA +96 -0
- mkdocs_mknodes-0.0.2.dist-info/RECORD +40 -0
- mkdocs_mknodes-0.0.2.dist-info/WHEEL +4 -0
- mkdocs_mknodes-0.0.2.dist-info/entry_points.txt +5 -0
- mkdocs_mknodes-0.0.2.dist-info/licenses/LICENSE +22 -0
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
/*required: admonitions, status_icons, accent_fg_color, primary_bg_color, tooltip_width
|
|
2
|
+
content_area_width, classic_admonition_style, show_annotation_numbers, default_icons, color_theme*/
|
|
3
|
+
:root {
|
|
4
|
+
{% for admonition in admonitions %}
|
|
5
|
+
--md-admonition-icon--{{ admonition.name }}: url('data:image/svg+xml;charset=utf-8,{{ admonition.svg }}');
|
|
6
|
+
{% endfor %}
|
|
7
|
+
{% for status_icon in status_icons %}
|
|
8
|
+
--md-status--encrypted: url('data:image/svg+xml;charset=utf-8,{ {status_icon.svg }}');
|
|
9
|
+
{% endfor %}
|
|
10
|
+
{% for k, v in default_icons.values() %}
|
|
11
|
+
--md-{k}: url('data:image/svg+xml;charset=utf-8,{{ v }}');
|
|
12
|
+
{% endfor %}
|
|
13
|
+
{% if accent_fg_color %}
|
|
14
|
+
--md-accent-fg-color: {{ accent_fg_color }};
|
|
15
|
+
--md-accent-fg-color--transparent: {{ accent_fg_color }};
|
|
16
|
+
{% endif %}
|
|
17
|
+
{% if primary_bg_color %}
|
|
18
|
+
--md-primary-bg-color: {{ primary_bg_color }};
|
|
19
|
+
--md-primary-bg-color--light: {{ primary_bg_color }};
|
|
20
|
+
{% endif %}
|
|
21
|
+
{% if color_theme %}
|
|
22
|
+
--md-primary-fg-color: {{ color_theme.color_str }};
|
|
23
|
+
--md-primary-fg-color--light: {{ color_theme.light_str }};
|
|
24
|
+
--md-primary-fg-color--dark: {{ color_theme.dark_str }};
|
|
25
|
+
{% endif %}
|
|
26
|
+
{% if tooltip_width %}
|
|
27
|
+
--md-tooltip-width: {{ tooltip_width }}px;
|
|
28
|
+
{% endif %}
|
|
29
|
+
}
|
|
30
|
+
{% for admonition in admonitions %}
|
|
31
|
+
.md-typeset .admonition.{{ admonition.name }},
|
|
32
|
+
.md-typeset details.{{ admonition.name }} {
|
|
33
|
+
border-color: {{ admonition.border_color }};
|
|
34
|
+
}
|
|
35
|
+
.md-typeset .admonition.{{ admonition.name }}:focus-within,
|
|
36
|
+
.md-typeset details.{{ admonition.name }}:focus-within {
|
|
37
|
+
box-shadow: 0 0 0 0.2rem {{ admonition.header_color }}; ## #00c8531a
|
|
38
|
+
}
|
|
39
|
+
.md-typeset .{{ admonition.name }} > .admonition-title,
|
|
40
|
+
.md-typeset .{{ admonition.name }} > summary {
|
|
41
|
+
background-color: {{ admonition.header_color }};
|
|
42
|
+
color: {{ admonition.font_color }};
|
|
43
|
+
}
|
|
44
|
+
.md-typeset .{{ admonition.name }} > .admonition-title:before,
|
|
45
|
+
.md-typeset .{{ admonition.name }} > summary:before {
|
|
46
|
+
background-color: {{admonition.icon_color}};
|
|
47
|
+
-webkit-mask-image: var(--md-admonition-icon--{{ admonition.name }});
|
|
48
|
+
mask-image: var(--md-admonition-icon--{{ admonition.name }});
|
|
49
|
+
}
|
|
50
|
+
.md-typeset .{{ admonition.name }} > .admonition-title:after,
|
|
51
|
+
.md-typeset .{{ admonition.name }} > summary:after {
|
|
52
|
+
color: {{ admonition.icon_color }}; ## #00c853
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
{% endfor %}
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
{% for status_icon in status_icons %}
|
|
59
|
+
.md-status--{{ status_icon.name }}:after {
|
|
60
|
+
-webkit-mask-image: var(--md-status--{{ status_icon.name }});
|
|
61
|
+
mask-image: var(--md-status--{{ status_icon.name }});
|
|
62
|
+
}
|
|
63
|
+
{% endfor %}
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
{% if content_area_width %}
|
|
67
|
+
.md-grid {
|
|
68
|
+
--max-width: {{ content_area_width }}px;
|
|
69
|
+
}
|
|
70
|
+
{% endif %}
|
|
71
|
+
|
|
72
|
+
{% if classic_admonition_style %}
|
|
73
|
+
.md-typeset .admonition, .md-typeset details {
|
|
74
|
+
--border-width: 0;
|
|
75
|
+
--border-left-width: 4px;
|
|
76
|
+
}
|
|
77
|
+
{% endif %}
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
{% if show_annotation_numbers %}
|
|
81
|
+
.md-typeset .md-annotation__index > ::before {
|
|
82
|
+
--content: attr(data-md-annotation-id);
|
|
83
|
+
}
|
|
84
|
+
.md-typeset :focus-within > .md-annotation__index > ::before {
|
|
85
|
+
--transform: none;
|
|
86
|
+
}
|
|
87
|
+
{% endif %}
|
|
88
|
+
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
@keyframes heart {
|
|
2
|
+
0%, 40%, 80%, to {
|
|
3
|
+
transform: scale(1);
|
|
4
|
+
}
|
|
5
|
+
20%, 60% {
|
|
6
|
+
transform: scale(1.15);
|
|
7
|
+
}
|
|
8
|
+
}.md-typeset .twitter {
|
|
9
|
+
color: #00acee;
|
|
10
|
+
}
|
|
11
|
+
.md-typeset .mastodon {
|
|
12
|
+
color: #897ff8;
|
|
13
|
+
}
|
|
14
|
+
.md-typeset .mdx-video {
|
|
15
|
+
width: auto;
|
|
16
|
+
}
|
|
17
|
+
.md-typeset .mdx-video__inner {
|
|
18
|
+
height: 0;
|
|
19
|
+
padding-bottom: 56.138%;
|
|
20
|
+
position: relative;
|
|
21
|
+
width: 100%}
|
|
22
|
+
.md-typeset .mdx-video iframe {
|
|
23
|
+
border: none;
|
|
24
|
+
height: 100%;
|
|
25
|
+
left: 0;
|
|
26
|
+
overflow: hidden;
|
|
27
|
+
position: absolute;
|
|
28
|
+
top: 0;
|
|
29
|
+
width: 100%}
|
|
30
|
+
.md-typeset .mdx-heart {
|
|
31
|
+
animation: heart 1s infinite;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
.md-typeset .mdx-switch button {
|
|
35
|
+
cursor: pointer;
|
|
36
|
+
transition: opacity .25s;
|
|
37
|
+
}
|
|
38
|
+
.md-typeset .mdx-switch button:focus, .md-typeset .mdx-switch button:hover {
|
|
39
|
+
opacity: .75;
|
|
40
|
+
}
|
|
41
|
+
.md-typeset .mdx-switch button>code {
|
|
42
|
+
background-color: var(--md-primary-fg-color);
|
|
43
|
+
color: var(--md-primary-bg-color);
|
|
44
|
+
display: block;
|
|
45
|
+
}
|
|
46
|
+
.md-typeset .mdx-columns ol, .md-typeset .mdx-columns ul {
|
|
47
|
+
-moz-columns: 2;
|
|
48
|
+
column-count: 2;
|
|
49
|
+
}
|
|
50
|
+
@media screen and (max-width:29.9375em) {
|
|
51
|
+
.md-typeset .mdx-columns ol, .md-typeset .mdx-columns ul {
|
|
52
|
+
-moz-columns: initial;
|
|
53
|
+
columns: initial;
|
|
54
|
+
}
|
|
55
|
+
}.md-typeset .mdx-columns li {
|
|
56
|
+
-moz-column-break-inside: avoid;
|
|
57
|
+
break-inside: avoid;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
.md-typeset .mdx-social {
|
|
61
|
+
height: min(27rem, 80vw);
|
|
62
|
+
position: relative;
|
|
63
|
+
}
|
|
64
|
+
.md-typeset .mdx-social:hover .mdx-social__image {
|
|
65
|
+
background-color: #e4e4e40d;
|
|
66
|
+
}
|
|
67
|
+
.md-typeset .mdx-social__layer {
|
|
68
|
+
margin-top: 4rem;
|
|
69
|
+
position: absolute;
|
|
70
|
+
transform-style: preserve-3d;
|
|
71
|
+
transition: .25s cubic-bezier(.7, 0, .3, 1);
|
|
72
|
+
}
|
|
73
|
+
.md-typeset .mdx-social__layer:hover .mdx-social__label {
|
|
74
|
+
opacity: 1;
|
|
75
|
+
}
|
|
76
|
+
.md-typeset .mdx-social__layer:hover .mdx-social__image {
|
|
77
|
+
background-color: #7f7f7ffc;
|
|
78
|
+
}
|
|
79
|
+
.md-typeset .mdx-social__layer:hover~.mdx-social__layer {
|
|
80
|
+
opacity: 0;
|
|
81
|
+
}
|
|
82
|
+
.md-typeset .mdx-social__image {
|
|
83
|
+
box-shadow: -.25rem .25rem .5rem #0000000d;
|
|
84
|
+
transform: rotate(-40deg) skew(15deg, 15deg) scale(.7);
|
|
85
|
+
transition: all .25s;
|
|
86
|
+
}
|
|
87
|
+
.md-typeset .mdx-social__image img {
|
|
88
|
+
display: block;
|
|
89
|
+
}
|
|
90
|
+
.md-typeset .mdx-social__label {
|
|
91
|
+
background-color: var(--md-default-fg-color--light);
|
|
92
|
+
color: var(--md-default-bg-color);
|
|
93
|
+
display: block;
|
|
94
|
+
opacity: 0;
|
|
95
|
+
padding: .2rem .4rem;
|
|
96
|
+
position: absolute;
|
|
97
|
+
transition: all .25s;
|
|
98
|
+
}
|
|
99
|
+
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(6) {
|
|
100
|
+
transform: translateY(-30px);
|
|
101
|
+
}
|
|
102
|
+
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(5) {
|
|
103
|
+
transform: translateY(-20px);
|
|
104
|
+
}
|
|
105
|
+
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(4) {
|
|
106
|
+
transform: translateY(-10px);
|
|
107
|
+
}
|
|
108
|
+
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(3) {
|
|
109
|
+
transform: translateY(0);
|
|
110
|
+
}
|
|
111
|
+
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(2) {
|
|
112
|
+
transform: translateY(10px);
|
|
113
|
+
}
|
|
114
|
+
.md-typeset .mdx-social:hover .mdx-social__layer:first-child {
|
|
115
|
+
transform: translateY(20px);
|
|
116
|
+
}
|
|
117
|
+
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(0) {
|
|
118
|
+
transform: translateY(30px);
|
|
119
|
+
}
|
|
120
|
+
.md-banner {
|
|
121
|
+
color: var(--md-footer-fg-color--lighter);
|
|
122
|
+
}
|
|
123
|
+
.md-banner strong {
|
|
124
|
+
white-space: nowrap;
|
|
125
|
+
}
|
|
126
|
+
.md-banner a, .md-banner strong {
|
|
127
|
+
color: var(--md-footer-fg-color);
|
|
128
|
+
}
|
|
129
|
+
.md-banner a:focus, .md-banner a:hover {
|
|
130
|
+
color: currentcolor;
|
|
131
|
+
}
|
|
132
|
+
.md-banner a:focus .twemoji, .md-banner a:hover .twemoji {
|
|
133
|
+
background-color: var(--md-footer-fg-color);
|
|
134
|
+
box-shadow: none;
|
|
135
|
+
}
|
|
136
|
+
.md-banner .twemoji {
|
|
137
|
+
border-radius: 100%;
|
|
138
|
+
box-shadow: inset 0 0 0 .05rem currentcolor;
|
|
139
|
+
display: inline-block;
|
|
140
|
+
height: 1.2rem;
|
|
141
|
+
padding: .25rem;
|
|
142
|
+
transition: all .25s;
|
|
143
|
+
vertical-align: bottom;
|
|
144
|
+
width: 1.2rem;
|
|
145
|
+
}
|
|
146
|
+
.md-banner .twemoji svg {
|
|
147
|
+
display: block;
|
|
148
|
+
max-height: none;
|
|
149
|
+
}
|
|
150
|
+
.mdx-container {
|
|
151
|
+
background: url("data:image/svg+xml;utf8, <svg xmlns='http: //www.w3.org/2000/svg' viewBox='0 0 1123 258'><path d='M1124, 2c0, 0 0, 256 0, 256l-1125, 0l0, -48c0, 0 16, 5 55, 5c116, 0 197, -92 325, -92c121, 0 114, 46 254, 46c140, 0 214, -167 572, -166Z' style='fill: hsla(0, 0%, 100%, 1)' /></svg>") no-repeat bottom, linear-gradient(to bottom, var(--md-primary-fg-color), #a63fd9 99%, var(--md-default-bg-color) 99%);
|
|
152
|
+
padding-top: 1rem;
|
|
153
|
+
}
|
|
154
|
+
[data-md-color-scheme=slate] .mdx-container {
|
|
155
|
+
background: url("data:image/svg+xml;utf8, <svg xmlns='http: //www.w3.org/2000/svg' viewBox='0 0 1123 258'><path d='M1124, 2c0, 0 0, 256 0, 256l-1125, 0l0, -48c0, 0 16, 5 55, 5c116, 0 197, -92 325, -92c121, 0 114, 46 254, 46c140, 0 214, -167 572, -166Z' style='fill: hsla(230, 15%, 14%, 1)' /></svg>") no-repeat bottom, linear-gradient(to bottom, var(--md-primary-fg-color), #363949 99%, var(--md-default-bg-color) 99%);
|
|
156
|
+
}
|
|
157
|
+
.mdx-hero {
|
|
158
|
+
color: var(--md-primary-bg-color);
|
|
159
|
+
margin: 0 .8rem;
|
|
160
|
+
}
|
|
161
|
+
.mdx-hero h1 {
|
|
162
|
+
color: currentcolor;
|
|
163
|
+
font-weight: 700;
|
|
164
|
+
margin-bottom: 1rem;
|
|
165
|
+
}
|
|
166
|
+
@media screen and (max-width:29.9375em) {
|
|
167
|
+
.mdx-hero h1 {
|
|
168
|
+
font-size: 1.4rem;
|
|
169
|
+
}
|
|
170
|
+
}.mdx-hero__content {
|
|
171
|
+
padding-bottom: 6rem;
|
|
172
|
+
}
|
|
173
|
+
@media screen and (min-width:60em) {
|
|
174
|
+
.mdx-hero {
|
|
175
|
+
align-items: stretch;
|
|
176
|
+
display: flex;
|
|
177
|
+
}
|
|
178
|
+
.mdx-hero__content {
|
|
179
|
+
margin-top: 3.5rem;
|
|
180
|
+
max-width: 19rem;
|
|
181
|
+
padding-bottom: 14vw;
|
|
182
|
+
}
|
|
183
|
+
.mdx-hero__image {
|
|
184
|
+
order: 1;
|
|
185
|
+
transform: translateX(4rem);
|
|
186
|
+
width: 38rem;
|
|
187
|
+
}
|
|
188
|
+
}@media screen and (min-width:76.25em) {
|
|
189
|
+
.mdx-hero__image {
|
|
190
|
+
transform: translateX(8rem);
|
|
191
|
+
}
|
|
192
|
+
}.mdx-hero .md-button {
|
|
193
|
+
color: var(--md-primary-bg-color);
|
|
194
|
+
margin-right: .5rem;
|
|
195
|
+
margin-top: .5rem;
|
|
196
|
+
}
|
|
197
|
+
.mdx-hero .md-button:focus, .mdx-hero .md-button:hover {
|
|
198
|
+
background-color: var(--md-accent-fg-color);
|
|
199
|
+
border-color: var(--md-accent-fg-color);
|
|
200
|
+
color: var(--md-accent-bg-color);
|
|
201
|
+
}
|
|
202
|
+
.mdx-hero .md-button--primary {
|
|
203
|
+
background-color: var(--md-primary-bg-color);
|
|
204
|
+
border-color: var(--md-primary-bg-color);
|
|
205
|
+
color: #894da8;
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
.md-typeset .mdx-premium p {
|
|
209
|
+
margin: 2em 0;
|
|
210
|
+
text-align: center;
|
|
211
|
+
}
|
|
212
|
+
.md-typeset .mdx-premium img {
|
|
213
|
+
height: 3.25rem;
|
|
214
|
+
}
|
|
215
|
+
.md-typeset .mdx-premium p:last-child {
|
|
216
|
+
display: flex;
|
|
217
|
+
flex-wrap: wrap;
|
|
218
|
+
justify-content: center;
|
|
219
|
+
}
|
|
220
|
+
.md-typeset .mdx-premium p:last-child>a {
|
|
221
|
+
display: block;
|
|
222
|
+
flex-shrink: 0;
|
|
223
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
An MkClassPage is an MkPage subclass used to display information about
|
|
2
|
+
a specific class. It uses a Jinja template to display the class-related information.
|
|
3
|
+
By default, the Docstrings, tables for sub and parent classes as well as an inheritance
|
|
4
|
+
graph are shown. The template can be adjusted manually in case a different layout
|
|
5
|
+
is preferred.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
This is an example for an MkClassPage with the default layout:
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
{{ example_class | MkClassPage(inclusion_level=False) }}
|
|
Binary file
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
## Plugin resources
|
|
2
|
+
|
|
3
|
+
### Files
|
|
4
|
+
|
|
5
|
+
All files connected to the node tree:
|
|
6
|
+
|
|
7
|
+
{{ page_mapping | MkPrettyPrint }}
|
|
8
|
+
|
|
9
|
+
### Plugins
|
|
10
|
+
|
|
11
|
+
Plugins used by the tree nodes:
|
|
12
|
+
|
|
13
|
+
{{ resources.plugins | MkPrettyPrint }}
|
|
14
|
+
|
|
15
|
+
### CSS
|
|
16
|
+
|
|
17
|
+
CSS used by the tree nodes:
|
|
18
|
+
|
|
19
|
+
{{ resources.css | MkPrettyPrint }}
|
|
20
|
+
|
|
21
|
+
### JS
|
|
22
|
+
|
|
23
|
+
JS used by the tree nodes:
|
|
24
|
+
|
|
25
|
+
{{ resources.js | MkPrettyPrint }}
|
|
26
|
+
|
|
27
|
+
### Markdown extensions
|
|
28
|
+
|
|
29
|
+
Extensions used by the tree nodes:
|
|
30
|
+
|
|
31
|
+
{{ resources.markdown_extensions | dump_yaml | MkCode(language="yaml") }}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
The following config...
|
|
2
|
+
|
|
3
|
+
{{ config | MkCode(language="yaml") }}
|
|
4
|
+
|
|
5
|
+
Combined with this CLI call...
|
|
6
|
+
|
|
7
|
+
{{"mknodes build" | MkCode(language="terminal")}}
|
|
8
|
+
|
|
9
|
+
Will create this website:
|
|
10
|
+
{{ "https://phil65.github.io/mknodes/mkdocstrings" | MkLink(as_button=True, icon="web") }}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
The following config...
|
|
2
|
+
|
|
3
|
+
{{ config | MkCode(language="yaml") }}
|
|
4
|
+
|
|
5
|
+
Combined with this CLI call...
|
|
6
|
+
|
|
7
|
+
{{"mknodes build" | MkCode(language="terminal")}}
|
|
8
|
+
|
|
9
|
+
Will create this website:
|
|
10
|
+
{{ "https://phil65.github.io/mknodes/mkdocs" | MkLink(as_button=True, icon="web") }}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
There are a lot of different ways MkNodes can be used to generate
|
|
2
|
+
websites. This section will highlight some of them.
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
**MkNodes** can be used in many different ways
|
|
6
|
+
|
|
7
|
+
* Create complete websites
|
|
8
|
+
* **MkNodes** can be used to create a whole website (like it is done with this page)
|
|
9
|
+
The most useful setup probably would be to put the whole navigation into code,
|
|
10
|
+
create MkCodes via code when the complexity favours that, and otherwise just
|
|
11
|
+
use `MkPage.from_file` or `MkJinjaTemplate` to embed static pages. That way
|
|
12
|
+
you can get the best of both worlds, the simplicity from writing markdown files
|
|
13
|
+
combined with the possibilities of using python for repititive work or
|
|
14
|
+
more complex / dynamic tasks.
|
|
15
|
+
|
|
16
|
+
* Load existing websites and extend it.
|
|
17
|
+
* By using `MkNav.parse.folder` / `MkNav.parse.file` as well as `MkPage.from_file`,
|
|
18
|
+
the existing Markdown pages can become part of our tree
|
|
19
|
+
(which we can then extend programatically). You dont need to start from ground
|
|
20
|
+
up if you have an existing documentation.
|
|
21
|
+
|
|
22
|
+
* Create a subsection with **MkNodes** and reference it from your "static" page.
|
|
23
|
+
* You can also create an MkNodes tree and reference that tree from your
|
|
24
|
+
`nav:` section in mkdocs.yml.
|
|
25
|
+
|
|
26
|
+
* Create single static pages / blocks for your page
|
|
27
|
+
You can also just use **MkNodes** to create some Nodes, stringify them and include
|
|
28
|
+
the markdown in your static pages. It can also be used to create your GitHub / PyPi
|
|
29
|
+
overview page.
|
|
30
|
+
|
|
31
|
+
* Using `Markdown-Exec` or similar inline execution plugins
|
|
32
|
+
You can also embed **MkNodes** code directly by using various plug-ins
|
|
33
|
+
(personal recommendation: `Markdown-Exec`) For most cases the built-in
|
|
34
|
+
jinja environment should include enough to display complex Markdown in an easy way.
|
|
35
|
+
|
|
36
|
+
* Create "multi-pages"
|
|
37
|
+
**MkNodes** can even "merge" multiple websites into one.
|
|
38
|
+
In its core, MkNodes is nothing more than one large tree ranging from the start page
|
|
39
|
+
down to individual markdown elements.
|
|
40
|
+
It´s easy to make a complete website tree the subtree of another Parent-tree.
|
|
41
|
+
|
|
42
|
+
* Create a "structure template" for multiple sites
|
|
43
|
+
MkNodes separates content and appearance for writing documentation. Website templates
|
|
44
|
+
can be written in a way that they work for multiple websites without any manual adaption.
|
|
45
|
+
(Check out the very basic included `MkDefaultWebsite` and `MkEmptyWebsite` nodes as an example)
|
|
46
|
+
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: mkdocs_mknodes
|
|
3
|
+
Version: 0.0.2
|
|
4
|
+
Summary: Don't write docs. Code them.
|
|
5
|
+
Project-URL: Documentation, https://phil65.github.io/mkdocs_mknodes/
|
|
6
|
+
Project-URL: Source, https://github.com/phil65/mkdocs_mknodes
|
|
7
|
+
Project-URL: Gitter, https://app.gitter.im/#/room/#mknodes:gitter.im
|
|
8
|
+
Author-email: Philipp Temminghoff <philipptemminghoff@gmail.com>
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: docs,docstrings,documentation,framework,internet,markdown
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
20
|
+
Classifier: Topic :: Documentation
|
|
21
|
+
Classifier: Topic :: Internet
|
|
22
|
+
Classifier: Topic :: Software Development :: Documentation
|
|
23
|
+
Classifier: Topic :: Software Development :: User Interfaces
|
|
24
|
+
Classifier: Topic :: Text Processing :: Markup :: Markdown
|
|
25
|
+
Requires-Python: >=3.11
|
|
26
|
+
Requires-Dist: coloraide
|
|
27
|
+
Requires-Dist: deepmerge
|
|
28
|
+
Requires-Dist: fsspec
|
|
29
|
+
Requires-Dist: jinja2
|
|
30
|
+
Requires-Dist: mkdocs-literate-nav
|
|
31
|
+
Requires-Dist: mkdocs-material>=9.4
|
|
32
|
+
Requires-Dist: mkdocs>=1.5
|
|
33
|
+
Requires-Dist: mkdocstrings[python]
|
|
34
|
+
Requires-Dist: mknodes
|
|
35
|
+
Requires-Dist: rich
|
|
36
|
+
Requires-Dist: typer
|
|
37
|
+
Description-Content-Type: text/markdown
|
|
38
|
+
|
|
39
|
+
``` py title='__main__.create_github_index_md' linenums="86" hl_lines="3"
|
|
40
|
+
def create_github_index_md() -> mknodes.MkPage:
|
|
41
|
+
page = mknodes.MkPage("Github index")
|
|
42
|
+
page += mknodes.MkCode.for_object(create_github_index_md)
|
|
43
|
+
page += mknodes.MkHeader("MkNodes", level=1)
|
|
44
|
+
page += mknodes.MkHeader("Don't write docs. Code them.", level=4)
|
|
45
|
+
page += mknodes.MkShields()
|
|
46
|
+
page += mknodes.MkLink(DOC_URL, "Read the completely coded documentation!")
|
|
47
|
+
page += mknodes.MkInstallGuide(header="How to install")
|
|
48
|
+
page += mknodes.MkHeader("All the nodes!")
|
|
49
|
+
page += mknodes.MkClassDiagram(mknodes.MkNode, mode="subclasses", direction="LR")
|
|
50
|
+
return page
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
# MkNodes (Mkdocs Plugin)
|
|
55
|
+
|
|
56
|
+
#### Don't write docs. Code them.
|
|
57
|
+
|
|
58
|
+
[](https://pypi.org/project/mknodes/)
|
|
59
|
+
[](https://pypi.org/project/mknodes/)
|
|
60
|
+
[](https://pypi.org/project/mknodes/)
|
|
61
|
+
[](https://pypi.org/project/mknodes/)
|
|
62
|
+
[](https://pypi.org/project/mknodes/)
|
|
63
|
+
[](https://pypi.org/project/mknodes/)
|
|
64
|
+
[](https://pypi.org/project/mknodes/)
|
|
65
|
+
[](https://pypi.org/project/mknodes/)
|
|
66
|
+
[](https://pypi.org/project/mknodes/)
|
|
67
|
+
[](https://github.com/phil65/mknodes/releases)
|
|
68
|
+
[](https://github.com/phil65/mknodes/graphs/contributors)
|
|
69
|
+
[](https://github.com/phil65/mknodes/discussions)
|
|
70
|
+
[](https://github.com/phil65/mknodes/forks)
|
|
71
|
+
[](https://github.com/phil65/mknodes/issues)
|
|
72
|
+
[](https://github.com/phil65/mknodes/pulls)
|
|
73
|
+
[](https://github.com/phil65/mknodes/watchers)
|
|
74
|
+
[](https://github.com/phil65/mknodes/stars)
|
|
75
|
+
[](https://github.com/phil65/mknodes)
|
|
76
|
+
[](https://github.com/phil65/mknodes/commits)
|
|
77
|
+
[](https://github.com/phil65/mknodes/releases)
|
|
78
|
+
[](https://github.com/phil65/mknodes)
|
|
79
|
+
[](https://github.com/phil65/mknodes)
|
|
80
|
+
[](https://github.com/phil65/mknodes)
|
|
81
|
+
[](https://github.com/phil65/mknodes)
|
|
82
|
+
[](https://codecov.io/gh/phil65/mknodes/)
|
|
83
|
+
[](https://github.com/psf/black)
|
|
84
|
+
[](https://pyup.io/repos/github/phil65/mknodes/)
|
|
85
|
+
|
|
86
|
+
[Read the completely coded documentation!](https://phil65.github.io/mknodes/)
|
|
87
|
+
|
|
88
|
+
## How to install
|
|
89
|
+
|
|
90
|
+
### pip
|
|
91
|
+
|
|
92
|
+
The latest released version is available at the [Python package index](https://pypi.org/project/mknodes).
|
|
93
|
+
|
|
94
|
+
``` py
|
|
95
|
+
pip install mknodes
|
|
96
|
+
```
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
mkdocs_mknodes/__init__.py,sha256=QvlVh4JTl3JL7jQAja76yKtT-IvF4631ASjWY1wS6AQ,22
|
|
2
|
+
mkdocs_mknodes/buildcollector.py,sha256=5Qla2itw_k8wO3_kfSAK7gfNW03QVEwYOUGeBOay4Xs,5594
|
|
3
|
+
mkdocs_mknodes/mkdocsconfig.py,sha256=L_mArs_5LxNC8rBBTvDQwpowgAEiMcpDHa9Bs1ELtaQ,4961
|
|
4
|
+
mkdocs_mknodes/paths.py,sha256=tx8c5JPvelTkr_aOqRy8s8kqB0NYoYARWPlsLyvdRJs,388
|
|
5
|
+
mkdocs_mknodes/cli/__init__.py,sha256=1iq-HZNVdvpZcYToCM1Z_QxvdWE18Csf_k1FgQTjhjg,7199
|
|
6
|
+
mkdocs_mknodes/manual/__init__.py,sha256=-2ekNF48yAMYLQUMNfV1s08CU2Kl_xo03koYhk-Nyf8,340
|
|
7
|
+
mkdocs_mknodes/manual/cli_section.py,sha256=mMKDmg0h41CepTaQ5CRc1dyqoAu2MjIT4zCZEnzVqk4,1246
|
|
8
|
+
mkdocs_mknodes/manual/dev_section.py,sha256=Of1VckOuAnz8eHv_Kc2qXKqSa1xGCBHmrYUKc0gDiJg,2011
|
|
9
|
+
mkdocs_mknodes/manual/github_index.py,sha256=tD2pEcstEA4dRYiJ6bG2cYX3srr_yPU0KYbzG-8H4iU,657
|
|
10
|
+
mkdocs_mknodes/manual/internals_section.py,sha256=Xl_Gc8UTylXGcRwkI8RryKEvZj0BCf9znmQu9YM9vvU,2441
|
|
11
|
+
mkdocs_mknodes/manual/multi_project.py,sha256=pipC5dnFJi6O-EgRx33bbO5qpHWSWtglhuRCHZ2Dg5U,696
|
|
12
|
+
mkdocs_mknodes/manual/root.py,sha256=6ozYhBZki_z2XofIbEPMeRro51QGYL_9yPeR6wLKU5I,3392
|
|
13
|
+
mkdocs_mknodes/manual/use_cases_section.py,sha256=UQwIEH4KOajLhSB0bfc3X9OVOJfel8uej1IhVmr5Sds,1319
|
|
14
|
+
mkdocs_mknodes/plugin/__init__.py,sha256=279f9qvUlh2p-Rmwq1emDiQZ5MekAdZGuFxwG-vh-qk,6122
|
|
15
|
+
mkdocs_mknodes/plugin/build_page.py,sha256=51VRDL7vV-VItqo7hfL3XR1R_QS5Xy26m9WEALQUUhs,5928
|
|
16
|
+
mkdocs_mknodes/plugin/buildbackend.py,sha256=NgxUAA3TeDyWK4Q44__DtmW1Llng-0RoDIOIWwDnHpU,1007
|
|
17
|
+
mkdocs_mknodes/plugin/linkreplacer.py,sha256=esa07-dDV6JCVH2HuLhZ8hnZZTZXlJPltRWGR1xMWws,1553
|
|
18
|
+
mkdocs_mknodes/plugin/markdownbackend.py,sha256=XLlz0cU8mEteubf9K-iyTEK5P2vlfU8MAFHIOP-CNgU,1035
|
|
19
|
+
mkdocs_mknodes/plugin/mkdocsbackend.py,sha256=n06MdRtbuuHSvsA3Mv8_W6mYWKKvvL5Hj6z5-hbMO8k,6988
|
|
20
|
+
mkdocs_mknodes/plugin/mkdocsbuilder.py,sha256=iL_5AnlkGWSZIVuHJRRQ3wfhXidR1cjgnTMOsH0C9Z4,4078
|
|
21
|
+
mkdocs_mknodes/plugin/mkdocshelpers.py,sha256=H6gMwR4ef-RqkxF7mbB7ospT-4--xVU2X3zaG4aWVns,552
|
|
22
|
+
mkdocs_mknodes/plugin/pluginconfig.py,sha256=zc0WniuACj4oPC52EIxOBx7PGaPAq96hCTt1LrEwDlg,1626
|
|
23
|
+
mkdocs_mknodes/plugin/serve.py,sha256=C47nTgnaGPtJp_3nL3kyhXLCT1cGBri9Mp0s0-hKzPY,6623
|
|
24
|
+
mkdocs_mknodes/resources/build_process.jinja,sha256=LtmQuA1QOU9ZUtnbZYTLBt9dY9eMf4j7uQvra--kDZ8,1828
|
|
25
|
+
mkdocs_mknodes/resources/cli_index.jinja,sha256=ADXqHX1sNKp4OwXcxrbrPFkGiKciIEnnGlaxHQPi_w4,674
|
|
26
|
+
mkdocs_mknodes/resources/material_css.jinja,sha256=hpnKqnhUzqeUHE8CzqBHHmcdj0Do5RFXJ-VPKxi0gbw,2966
|
|
27
|
+
mkdocs_mknodes/resources/material_css_extra.jinja,sha256=KrKvTqcfSwi6TdrHxw4qwC32HAbQ33em25jAPaWpl1A,6099
|
|
28
|
+
mkdocs_mknodes/resources/mkclasspage.jinja,sha256=s0nykGtHuQI9W51Rm5UJkOVKRyG5DNt3A6NjEGGssdE,469
|
|
29
|
+
mkdocs_mknodes/resources/mkdocs_css.jinja,sha256=T51JY62IUNOgWJAVhDlXLxxl22xz6WW3lpku-hSSpII,259
|
|
30
|
+
mkdocs_mknodes/resources/modulepage.md,sha256=XNtgaQYcOOaBXkduH3nue_MzhK6pAc3NYfHFaunJTjM,136
|
|
31
|
+
mkdocs_mknodes/resources/python_objects.inv,sha256=SJwApOsoEiss9-BmVGyC-AVPJZPgiT0rZ00YhtckhfM,132601
|
|
32
|
+
mkdocs_mknodes/resources/requirements.md,sha256=oVhos55rof9E1qke0jur_xI6jjklTsVV6LhP1_FF7xo,477
|
|
33
|
+
mkdocs_mknodes/resources/use_case_by_config.jinja,sha256=HTNvkCyU5gyFPN5OLDPDSrhsXE68IXx27d7F_W1GYKE,265
|
|
34
|
+
mkdocs_mknodes/resources/use_case_default_website.jinja,sha256=H6hclSDN5pe9Qy0vRL8CUVvsQ4JJmtQmkPWT4A9pR1k,259
|
|
35
|
+
mkdocs_mknodes/resources/use_cases_index.jinja,sha256=QKuM1aQjwr61YhoXN_fFLvE2cr-GSR_oBQiJHMgUWeA,2425
|
|
36
|
+
mkdocs_mknodes-0.0.2.dist-info/METADATA,sha256=VWhwqgZWyfysC9ti3aeLNO1xRTfkr_rku_z1kwpZQ0M,5600
|
|
37
|
+
mkdocs_mknodes-0.0.2.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
|
|
38
|
+
mkdocs_mknodes-0.0.2.dist-info/entry_points.txt,sha256=vNFIsfl-SuMeXwlEHSAnCS4ItI1v8SOKfUwDqLR7U8s,122
|
|
39
|
+
mkdocs_mknodes-0.0.2.dist-info/licenses/LICENSE,sha256=W2XBRjTD89EfxvgU7BPVuFktBVTGX4onwNYIyEGQDs4,1078
|
|
40
|
+
mkdocs_mknodes-0.0.2.dist-info/RECORD,,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023, Philipp Temminghoff
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|