docmedown 0.1.0 → 0.1.1

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.
Files changed (32) hide show
  1. package/README.md +31 -0
  2. package/dist/cli.js +665 -507
  3. package/dist/docmedown.cjs +105 -41
  4. package/dist/docmedown.iife.js +106 -42
  5. package/dist/docmedown.mjs +7753 -4477
  6. package/dist/types/runtime/app.d.ts +3 -3
  7. package/dist/types/runtime/components/Builtins.d.ts +3 -3
  8. package/dist/types/runtime/components/Content.d.ts +1 -1
  9. package/dist/types/runtime/components/DmdRegistry.d.ts +1 -1
  10. package/dist/types/runtime/components/Layout.d.ts +1 -1
  11. package/dist/types/runtime/components/Navbar.d.ts +1 -1
  12. package/dist/types/runtime/components/Sidebar.d.ts +1 -1
  13. package/dist/types/runtime/components/TableOfContents.d.ts +2 -2
  14. package/dist/types/runtime/config-schema.d.ts +344 -0
  15. package/dist/types/runtime/config.d.ts +10 -3
  16. package/dist/types/runtime/index.d.ts +6 -5
  17. package/dist/types/runtime/loader/auto-indexer.d.ts +1 -1
  18. package/dist/types/runtime/loader/local-loader.d.ts +1 -1
  19. package/dist/types/runtime/loader/remote-github.d.ts +2 -2
  20. package/dist/types/runtime/loader/remote-gitlab.d.ts +2 -2
  21. package/dist/types/runtime/markdown/callouts.d.ts +1 -1
  22. package/dist/types/runtime/markdown/highlighter.d.ts +16 -16
  23. package/dist/types/runtime/markdown/parser.d.ts +1 -1
  24. package/dist/types/runtime/markdown/renderer.d.ts +1 -1
  25. package/dist/types/runtime/provider/DocProvider.d.ts +5 -5
  26. package/dist/types/runtime/provider/ThemeProvider.d.ts +3 -3
  27. package/dist/types/runtime/search/SearchModal.d.ts +2 -2
  28. package/dist/types/runtime/search/search-index.d.ts +1 -1
  29. package/dist/types/runtime/types.d.ts +25 -99
  30. package/package.json +11 -3
  31. package/schemas/docs.schema.json +157 -0
  32. package/templates/docs.json +1 -0
package/README.md CHANGED
@@ -216,8 +216,11 @@ The standard build embeds `.dmd/components.js` in `docs/.dist/index.html`, so th
216
216
 
217
217
  ## ⚙️ Configuration Reference (`docs.json`)
218
218
 
219
+ DocMeDown validates configuration from `docs.json`, `dmd.json`, inline `#dmd-config` JSON, and embedded manifests before applying defaults. Add the published JSON Schema reference for editor completion and immediate feedback:
220
+
219
221
  ```json
220
222
  {
223
+ "$schema": "https://raw.githubusercontent.com/gabrielmsilva00/docmedown/main/schemas/docs.schema.json",
221
224
  "name": "My Documentation",
222
225
  "tagline": "The simplest Markdown documenter yet",
223
226
  "version": "1.0.0",
@@ -245,6 +248,8 @@ The standard build embeds `.dmd/components.js` in `docs/.dist/index.html`, so th
245
248
  }
246
249
  ```
247
250
 
251
+ Unknown keys are rejected. The npm package also ships the portable schema at `schemas/docs.schema.json`; TypeScript consumers can import `docConfigSchema` and `parseDocConfig` from `docmedown`. See the full [configuration reference](./docs/configuration.md) for every field and validation rule.
252
+
248
253
  ### Color Presets Available
249
254
 
250
255
  | Preset | Accent Color | Vibe |
@@ -275,3 +280,29 @@ The standard build embeds `.dmd/components.js` in `docs/.dist/index.html`, so th
275
280
  ## 📄 License
276
281
 
277
282
  MIT © DocMeDown Contributors
283
+
284
+ ---
285
+
286
+ ## 🚀 Maintainer release command
287
+
288
+ Maintainers publish a prepared version with one command:
289
+
290
+ ```bash
291
+ npm run deploy
292
+ ```
293
+
294
+ It validates the release, pushes `main` and `v<version>` to GitHub, publishes to npm, and verifies the npm registry. Run `npm run deploy:dry-run` to validate without changing GitHub or npm.
295
+
296
+ ## 🧹 Quality checks
297
+
298
+ DocMeDown uses [Biome](https://biomejs.dev/) for formatting, import organization, and linting, and Zod for runtime configuration validation.
299
+
300
+ ```bash
301
+ npm run lint # check formatting, imports, and lint rules
302
+ npm run lint:fix # apply Biome fixes
303
+ npm run format # format maintained source files
304
+ npm run typecheck
305
+ npm test
306
+ ```
307
+
308
+ `npm run test:release` runs all of these checks plus production, documentation, and package smoke builds.