@prudentbird/voxx 1.0.0

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 (36) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +41 -0
  3. package/dist/index.mjs +1346 -0
  4. package/dist/index.mjs.map +1 -0
  5. package/package.json +65 -0
  6. package/templates/blog/hello-world.md.tpl +42 -0
  7. package/templates/blog/layout.tsx.tpl +44 -0
  8. package/templates/blog/page.tsx.tpl +27 -0
  9. package/templates/blog/post-list.tsx.tpl +45 -0
  10. package/templates/blog/post-page.tsx.tpl +41 -0
  11. package/templates/blog/slug-page.tsx.tpl +40 -0
  12. package/templates/changelog/layout.tsx.tpl +44 -0
  13. package/templates/changelog/page.tsx.tpl +27 -0
  14. package/templates/changelog/release-list.tsx.tpl +33 -0
  15. package/templates/changelog/release.md.tpl +15 -0
  16. package/templates/docs/doc-page.tsx.tpl +65 -0
  17. package/templates/docs/getting-started-index.md.tpl +9 -0
  18. package/templates/docs/index.md.tpl +16 -0
  19. package/templates/docs/installation.md.tpl +17 -0
  20. package/templates/docs/layout-root.tsx.tpl +52 -0
  21. package/templates/docs/layout.tsx.tpl +37 -0
  22. package/templates/docs/mobile-nav.tsx.tpl +90 -0
  23. package/templates/docs/page.tsx.tpl +50 -0
  24. package/templates/docs/sidebar-nav.tsx.tpl +39 -0
  25. package/templates/shared/content-version.ts.tpl +1 -0
  26. package/templates/shared/data.ts.tpl +34 -0
  27. package/templates/shared/instrumentation.ts.tpl +5 -0
  28. package/templates/shared/llms-full-route.ts.tpl +9 -0
  29. package/templates/shared/llms-route.ts.tpl +9 -0
  30. package/templates/shared/metadata.ts.tpl +39 -0
  31. package/templates/shared/on-this-page.tsx.tpl +213 -0
  32. package/templates/shared/robots.ts.tpl +13 -0
  33. package/templates/shared/rss-route.ts.tpl +9 -0
  34. package/templates/shared/sitemap.ts.tpl +23 -0
  35. package/templates/shared/theme-toggle.tsx.tpl +64 -0
  36. package/templates/shared/voxx.json.tpl +26 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 prudentbird
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.
package/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # voxx
2
+
3
+ A zero-friction CMS for you and your agents. Write markdown the way you ship code, and Voxx handles the rest.
4
+
5
+ ```bash
6
+ npx voxx init # scaffold a blog into your Next.js app
7
+ npx voxx init docs # or a docs site
8
+ npx voxx init changelog # or a release-notes page
9
+ ```
10
+
11
+ ## Commands
12
+
13
+ ### `voxx init [blog|docs|changelog]`
14
+
15
+ Scaffolds a surface into your app:
16
+
17
+ - **Next.js detected** — writes routes under `app/<basePath>/` (private `_voxx/` folder for the data layer and components — all yours to restyle), `rss.xml`/`llms.txt`/`llms-full.txt` routes plus a sitemap and `robots.ts` where the type calls for them, and enables `cacheComponents` in your next.config when it's safe to (Next 16+, recognizable config shape).
18
+ - **No Next.js** — asks whether you want a static site (`voxx build`) or a fresh app via `create-next-app`, then scaffolds into it.
19
+
20
+ Flags: `--base /notes` (mount path — routes follow it), `--dir content`, `--app src/app`, `--force`.
21
+
22
+ ### `voxx new "Title"`
23
+
24
+ Type-aware: creates a date-prefixed post (blog), an order-prefixed page (`--section getting-started --order 2`, docs), or a versioned release file (`voxx new "1.4.0"`, changelog).
25
+
26
+ ### `voxx build`
27
+
28
+ Renders the whole site to static HTML in `./dist` — post list, docs tree with sidebar + prev/next, or release timeline — plus `rss.xml`, `sitemap.xml`, `robots.txt`, `llms.txt`, and `llms-full.txt` per your feature flags. Images and other content assets are copied through, and every collection in a multi-collection config is built in one pass (each blog/changelog surface gets its own feed under its base path).
29
+
30
+ ### `voxx dev`
31
+
32
+ A preview server for static sites: builds to a temp directory, watches `voxx.json` and your content folders, rebuilds on change, and serves the result on `--port` (default 4321). Drafts are included by default so you can review them at their real URLs.
33
+
34
+ ## Content conventions
35
+
36
+ - Folders become docs sections; `index.md` is a section's landing page.
37
+ - `01-install.md` pins ordering without leaking into the URL (`/docs/install`).
38
+ - `2026-06-11-hello.md` date-stamps a post; frontmatter always wins.
39
+ - Release files are named by version (`1.4.0.md`) or carry `version:` frontmatter.
40
+
41
+ Configuration lives in `voxx.json` (JSON-schema autocompleted). The engine is [`@prudentbird/voxx-core`](../core) — use it directly if you'd rather bring your own framework.