dogsbay 0.2.0-beta.4 → 0.2.0-beta.5
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/dist/commands/site-init.js +31 -22
- package/package.json +9 -9
|
@@ -253,24 +253,28 @@ title: About
|
|
|
253
253
|
Whatever you want to say here.
|
|
254
254
|
\`\`\`
|
|
255
255
|
|
|
256
|
-
Then add it to \`content/nav.yml\` so it appears in the sidebar
|
|
256
|
+
Then add it to \`content/nav.yml\` so it appears in the sidebar.
|
|
257
|
+
Each entry is a single-key map — key = label, value = file path:
|
|
257
258
|
|
|
258
259
|
\`\`\`yaml
|
|
259
|
-
-
|
|
260
|
-
|
|
260
|
+
- About: about.md
|
|
261
|
+
\`\`\`
|
|
262
|
+
|
|
263
|
+
External URLs work the same way:
|
|
264
|
+
|
|
265
|
+
\`\`\`yaml
|
|
266
|
+
- GitHub: https://github.com/your-org/your-repo
|
|
261
267
|
\`\`\`
|
|
262
268
|
|
|
263
269
|
## 3. Group pages
|
|
264
270
|
|
|
265
|
-
To create a section in the sidebar,
|
|
271
|
+
To create a section in the sidebar, give the entry a list of
|
|
272
|
+
children instead of a single file:
|
|
266
273
|
|
|
267
274
|
\`\`\`yaml
|
|
268
|
-
-
|
|
269
|
-
|
|
270
|
-
-
|
|
271
|
-
href: ${basePath}/guides/configuration
|
|
272
|
-
- label: Deployment
|
|
273
|
-
href: ${basePath}/guides/deployment
|
|
275
|
+
- Guides:
|
|
276
|
+
- Configuration: guides/configuration.md
|
|
277
|
+
- Deployment: guides/deployment.md
|
|
274
278
|
\`\`\`
|
|
275
279
|
|
|
276
280
|
The folder structure under \`content/\` doesn't have to match the
|
|
@@ -281,19 +285,24 @@ nav — but it usually does, because it makes URLs predictable.
|
|
|
281
285
|
writeFileSync(navPath, `# Sidebar navigation. Loaded by Dogsbay automatically — name this
|
|
282
286
|
# file nav.yml, nav.yaml, or nav.json (in that order of precedence).
|
|
283
287
|
#
|
|
284
|
-
# Each entry is
|
|
285
|
-
#
|
|
286
|
-
# -
|
|
287
|
-
# -
|
|
288
|
+
# Each entry is a single-key map. The key is the sidebar label.
|
|
289
|
+
# The value is one of:
|
|
290
|
+
# - a file path (relative to content/, e.g. "guide.md")
|
|
291
|
+
# - an absolute URL (e.g. "https://...")
|
|
292
|
+
# - a list of child entries (creates a group)
|
|
293
|
+
#
|
|
294
|
+
# Examples:
|
|
295
|
+
# - Home: index.md # leaf — file path
|
|
296
|
+
# - GitHub: https://github.com/… # leaf — external URL
|
|
297
|
+
# - Guides: # group — children below
|
|
298
|
+
# - Configuration: guides/config.md
|
|
299
|
+
# - Deployment: guides/deploy.md
|
|
288
300
|
#
|
|
289
|
-
#
|
|
290
|
-
#
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
-
|
|
294
|
-
href: ${basePath}/
|
|
295
|
-
- label: Getting started
|
|
296
|
-
href: ${basePath}/getting-started
|
|
301
|
+
# Edit freely as you add or rearrange pages. See
|
|
302
|
+
# https://github.com/dogsbay/dogsbay for the full nav-file reference.
|
|
303
|
+
|
|
304
|
+
- Home: index.md
|
|
305
|
+
- Getting started: getting-started.md
|
|
297
306
|
`);
|
|
298
307
|
written.push(navPath);
|
|
299
308
|
return written;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dogsbay",
|
|
3
|
-
"version": "0.2.0-beta.
|
|
3
|
+
"version": "0.2.0-beta.5",
|
|
4
4
|
"description": "CLI for Dogsbay — scaffold, build, and serve documentation sites with markdown / MkDocs / Obsidian / OpenAPI sources",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -30,14 +30,14 @@
|
|
|
30
30
|
"picocolors": "^1.1.0",
|
|
31
31
|
"prompts": "^2.4.2",
|
|
32
32
|
"yaml": "^2.8.3",
|
|
33
|
-
"@dogsbay/format-mkdocs": "0.2.0-beta.
|
|
34
|
-
"@dogsbay/format-astro": "0.2.0-beta.
|
|
35
|
-
"@dogsbay/format-
|
|
36
|
-
"@dogsbay/format-
|
|
37
|
-
"@dogsbay/format-
|
|
38
|
-
"@dogsbay/format-
|
|
39
|
-
"@dogsbay/format-openapi": "0.2.0-beta.
|
|
40
|
-
"@dogsbay/types": "0.2.0-beta.
|
|
33
|
+
"@dogsbay/format-mkdocs": "0.2.0-beta.5",
|
|
34
|
+
"@dogsbay/format-astro": "0.2.0-beta.5",
|
|
35
|
+
"@dogsbay/format-obsidian": "0.2.0-beta.5",
|
|
36
|
+
"@dogsbay/format-mdx": "0.2.0-beta.5",
|
|
37
|
+
"@dogsbay/format-dogsbay-md": "0.2.0-beta.5",
|
|
38
|
+
"@dogsbay/format-starlight": "0.2.0-beta.5",
|
|
39
|
+
"@dogsbay/format-openapi": "0.2.0-beta.5",
|
|
40
|
+
"@dogsbay/types": "0.2.0-beta.5"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"@types/node": "^22.0.0",
|