@mgks/docmd 0.1.1 → 0.1.3
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.
- package/.github/workflows/publish.yml +1 -1
- package/README.md +3 -1
- package/assets/css/welcome.css +362 -0
- package/assets/images/preview-dark-1.png +0 -0
- package/assets/images/preview-dark-2.png +0 -0
- package/assets/images/preview-dark-3.png +0 -0
- package/assets/images/preview-light-1.png +0 -0
- package/assets/images/preview-light-2.png +0 -0
- package/assets/images/preview-light-3.png +0 -0
- package/bin/docmd.js +4 -2
- package/config.js +5 -2
- package/docs/content/no-style-example.md +110 -0
- package/docs/content/no-style-pages.md +202 -0
- package/docs/index.md +140 -53
- package/docs/overview.md +56 -0
- package/docs/theming/assets-management.md +126 -0
- package/docs/theming/custom-css-js.md +2 -36
- package/package.json +1 -2
- package/src/assets/css/docmd-main.css +3 -1
- package/src/commands/build.js +282 -205
- package/src/commands/dev.js +163 -35
- package/src/commands/init.js +117 -6
- package/src/core/file-processor.js +67 -5
- package/src/core/html-generator.js +16 -3
- package/src/plugins/sitemap.js +24 -3
- package/src/templates/layout.ejs +1 -1
- package/src/templates/no-style.ejs +159 -0
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
|
|
7
|
+
<% if (frontmatter.components?.meta !== false) { %>
|
|
8
|
+
<%- metaTagsHtml || '' %>
|
|
9
|
+
<title><%= pageTitle %><% if (frontmatter.components?.siteTitle !== false) { %> | <%= siteTitle %><% } %></title>
|
|
10
|
+
<% if (description && !(metaTagsHtml && metaTagsHtml.includes('name="description"'))) { %>
|
|
11
|
+
<meta name="description" content="<%= description %>">
|
|
12
|
+
<% } %>
|
|
13
|
+
<% } %>
|
|
14
|
+
|
|
15
|
+
<% if (frontmatter.components?.favicon !== false) { %>
|
|
16
|
+
<%- faviconLinkHtml || '' %>
|
|
17
|
+
<% } %>
|
|
18
|
+
|
|
19
|
+
<% if (frontmatter.components?.css !== false) { %>
|
|
20
|
+
<link rel="stylesheet" href="<%= relativePathToRoot %>assets/css/docmd-main.css">
|
|
21
|
+
<% if (frontmatter.components?.highlight !== false) { %>
|
|
22
|
+
<link rel="stylesheet" href="<%= relativePathToRoot %>assets/css/docmd-highlight-<%= defaultMode === 'dark' ? 'dark' : 'light' %>.css" id="highlight-theme">
|
|
23
|
+
<% } %>
|
|
24
|
+
<% } %>
|
|
25
|
+
|
|
26
|
+
<% if (frontmatter.components?.theme !== false) { %>
|
|
27
|
+
<%- themeCssLinkHtml || '' %>
|
|
28
|
+
<% } %>
|
|
29
|
+
|
|
30
|
+
<% if (frontmatter.components?.customCss !== false && customCssFiles && customCssFiles.length > 0) { %>
|
|
31
|
+
<% customCssFiles.forEach(cssFile => { %>
|
|
32
|
+
<link rel="stylesheet" href="<%= relativePathToRoot %><%- cssFile.startsWith('/') ? cssFile.substring(1) : cssFile %>">
|
|
33
|
+
<% }); %>
|
|
34
|
+
<% } %>
|
|
35
|
+
|
|
36
|
+
<% if (frontmatter.components?.pluginStyles !== false) { %>
|
|
37
|
+
<%- pluginStylesHtml || '' %>
|
|
38
|
+
<% } %>
|
|
39
|
+
|
|
40
|
+
<% if (frontmatter.components?.pluginHeadScripts !== false) { %>
|
|
41
|
+
<%- pluginHeadScriptsHtml || '' %>
|
|
42
|
+
<% } %>
|
|
43
|
+
|
|
44
|
+
<% if (frontmatter.customHead) { %>
|
|
45
|
+
<%- frontmatter.customHead %>
|
|
46
|
+
<% } %>
|
|
47
|
+
</head>
|
|
48
|
+
<body<% if (frontmatter.components?.theme !== false) { %> data-theme="<%= defaultMode %>"<% } %><% if (frontmatter.bodyClass) { %> class="<%= frontmatter.bodyClass %>"<% } %>>
|
|
49
|
+
<% if (frontmatter.components?.layout === true || frontmatter.components?.layout === 'full') { %>
|
|
50
|
+
<div class="main-content-wrapper">
|
|
51
|
+
<% if (frontmatter.components?.header !== false) { %>
|
|
52
|
+
<header class="page-header">
|
|
53
|
+
<% if (frontmatter.components?.pageTitle !== false) { %>
|
|
54
|
+
<h1><%= pageTitle %></h1>
|
|
55
|
+
<% } %>
|
|
56
|
+
</header>
|
|
57
|
+
<% } %>
|
|
58
|
+
<main class="content-area">
|
|
59
|
+
<div class="content-layout">
|
|
60
|
+
<div class="main-content">
|
|
61
|
+
<%- content %>
|
|
62
|
+
</div>
|
|
63
|
+
</div>
|
|
64
|
+
</main>
|
|
65
|
+
<% if (frontmatter.components?.footer !== false) { %>
|
|
66
|
+
<footer class="page-footer">
|
|
67
|
+
<div class="footer-content">
|
|
68
|
+
<div class="user-footer">
|
|
69
|
+
<%- footerHtml || '' %>
|
|
70
|
+
</div>
|
|
71
|
+
<% if (frontmatter.components?.branding !== false) { %>
|
|
72
|
+
<div class="branding-footer">
|
|
73
|
+
Build with <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M19 14c1.49-1.46 3-3.21 3-5.5A5.5 5.5 0 0 0 16.5 3c-1.76 0-3 .5-4.5 2-1.5-1.5-2.74-2-4.5-2A5.5 5.5 0 0 0 2 8.5c0 2.3 1.5 4.05 3 5.5l7 7Z"></path><path d="M12 5 9.04 7.96a2.17 2.17 0 0 0 0 3.08c.82.82 2.13.85 3 .07l2.07-1.9a2.82 2.82 0 0 1 3.79 0l2.96 2.66"></path><path d="m18 15-2-2"></path><path d="m15 18-2-2"></path></svg> <a href="https://docmd.mgks.dev" target="_blank" rel="noopener">docmd.</a>
|
|
74
|
+
</div>
|
|
75
|
+
<% } %>
|
|
76
|
+
</div>
|
|
77
|
+
</footer>
|
|
78
|
+
<% } %>
|
|
79
|
+
</div>
|
|
80
|
+
<% } else if (frontmatter.components?.sidebar === true) { %>
|
|
81
|
+
<aside class="sidebar">
|
|
82
|
+
<% if (frontmatter.components?.logo !== false && logo && logo.light && logo.dark) { %>
|
|
83
|
+
<div class="sidebar-header">
|
|
84
|
+
<a href="<%= logo.href || (relativePathToRoot + 'index.html') %>" class="logo-link">
|
|
85
|
+
<img src="<%= relativePathToRoot %><%- logo.light.startsWith('/') ? logo.light.substring(1) : logo.light %>" alt="<%= logo.alt || siteTitle %>" class="logo-light" <% if (logo.height) { %>style="height: <%= logo.height %>;"<% } %>>
|
|
86
|
+
<img src="<%= relativePathToRoot %><%- logo.dark.startsWith('/') ? logo.dark.substring(1) : logo.dark %>" alt="<%= logo.alt || siteTitle %>" class="logo-dark" <% if (logo.height) { %>style="height: <%= logo.height %>;"<% } %>>
|
|
87
|
+
</a>
|
|
88
|
+
</div>
|
|
89
|
+
<% } %>
|
|
90
|
+
<% if (frontmatter.components?.navigation !== false) { %>
|
|
91
|
+
<%- navigationHtml %>
|
|
92
|
+
<% } %>
|
|
93
|
+
<% if (frontmatter.components?.themeToggle !== false && theme && theme.enableModeToggle) { %>
|
|
94
|
+
<button id="theme-toggle-button" aria-label="Toggle theme" class="theme-toggle-button">
|
|
95
|
+
<%- renderIcon('sun', { class: 'icon-sun' }) %>
|
|
96
|
+
<%- renderIcon('moon', { class: 'icon-moon' }) %>
|
|
97
|
+
</button>
|
|
98
|
+
<% } %>
|
|
99
|
+
</aside>
|
|
100
|
+
<div class="main-content-wrapper">
|
|
101
|
+
<% if (frontmatter.components?.header !== false) { %>
|
|
102
|
+
<header class="page-header">
|
|
103
|
+
<% if (frontmatter.components?.pageTitle !== false) { %>
|
|
104
|
+
<h1><%= pageTitle %></h1>
|
|
105
|
+
<% } %>
|
|
106
|
+
</header>
|
|
107
|
+
<% } %>
|
|
108
|
+
<main class="content-area">
|
|
109
|
+
<div class="content-layout">
|
|
110
|
+
<div class="main-content">
|
|
111
|
+
<%- content %>
|
|
112
|
+
</div>
|
|
113
|
+
<% if (frontmatter.components?.toc !== false && headings && headings.length > 0) { %>
|
|
114
|
+
<div class="toc-sidebar">
|
|
115
|
+
<%- include('toc', { content, headings, navigationHtml, isActivePage }) %>
|
|
116
|
+
</div>
|
|
117
|
+
<% } %>
|
|
118
|
+
</div>
|
|
119
|
+
</main>
|
|
120
|
+
<% if (frontmatter.components?.footer !== false) { %>
|
|
121
|
+
<footer class="page-footer">
|
|
122
|
+
<div class="footer-content">
|
|
123
|
+
<div class="user-footer">
|
|
124
|
+
<%- footerHtml || '' %>
|
|
125
|
+
</div>
|
|
126
|
+
<% if (frontmatter.components?.branding !== false) { %>
|
|
127
|
+
<div class="branding-footer">
|
|
128
|
+
Build with <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M19 14c1.49-1.46 3-3.21 3-5.5A5.5 5.5 0 0 0 16.5 3c-1.76 0-3 .5-4.5 2-1.5-1.5-2.74-2-4.5-2A5.5 5.5 0 0 0 2 8.5c0 2.3 1.5 4.05 3 5.5l7 7Z"></path><path d="M12 5 9.04 7.96a2.17 2.17 0 0 0 0 3.08c.82.82 2.13.85 3 .07l2.07-1.9a2.82 2.82 0 0 1 3.79 0l2.96 2.66"></path><path d="m18 15-2-2"></path><path d="m15 18-2-2"></path></svg> <a href="https://docmd.mgks.dev" target="_blank" rel="noopener">docmd.</a>
|
|
129
|
+
</div>
|
|
130
|
+
<% } %>
|
|
131
|
+
</div>
|
|
132
|
+
</footer>
|
|
133
|
+
<% } %>
|
|
134
|
+
</div>
|
|
135
|
+
<% } else { %>
|
|
136
|
+
<%- content %>
|
|
137
|
+
<% } %>
|
|
138
|
+
|
|
139
|
+
<% if (frontmatter.components?.scripts !== false) { %>
|
|
140
|
+
<% if (frontmatter.components?.themeToggle !== false) { %>
|
|
141
|
+
<script src="<%= relativePathToRoot %>assets/js/docmd-theme-toggle.js"></script>
|
|
142
|
+
<% } %>
|
|
143
|
+
|
|
144
|
+
<% if (frontmatter.components?.customJs !== false && customJsFiles && customJsFiles.length > 0) { %>
|
|
145
|
+
<% customJsFiles.forEach(jsFile => { %>
|
|
146
|
+
<script src="<%= relativePathToRoot %><%- jsFile.startsWith('/') ? jsFile.substring(1) : jsFile %>"></script>
|
|
147
|
+
<% }); %>
|
|
148
|
+
<% } %>
|
|
149
|
+
|
|
150
|
+
<% if (frontmatter.components?.pluginBodyScripts !== false) { %>
|
|
151
|
+
<%- pluginBodyScriptsHtml || '' %>
|
|
152
|
+
<% } %>
|
|
153
|
+
<% } %>
|
|
154
|
+
|
|
155
|
+
<% if (frontmatter.customScripts) { %>
|
|
156
|
+
<%- frontmatter.customScripts %>
|
|
157
|
+
<% } %>
|
|
158
|
+
</body>
|
|
159
|
+
</html>
|