@life-and-dev/mdsite 0.3.0 → 0.3.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 (2) hide show
  1. package/README.md +20 -13
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -10,26 +10,32 @@ You write Markdown. For example, your content directory with a few pages and a l
10
10
 
11
11
  ```text
12
12
  my-docs/
13
- ├── index.md
14
- ├── about.md
15
- ├── blog/
16
- │ ├── 2026-01-hello.md
17
- │ └── 2026-03-release.md
18
- └── logo.png
13
+ └── content
14
+ ├── index.md
15
+ ├── about.md
16
+ ├── blog/
17
+ │ ├── 2026-01-hello.md
18
+ │ └── 2026-03-release.md
19
+ └── logo.png
19
20
  ```
20
21
 
22
+ Your source tree is only Markdown files and images — no `node_modules`, no HTML, no build config.
23
+
21
24
  1. After you run `mdsite init` it creates `mdsite.yml` and required project files.
22
25
  2. Configure `mdsite.yml` as needed.
23
26
  3. Then run `mdsite generate` builds a static website under `.output/public/`:
24
27
 
28
+ For example:
29
+
25
30
  ```text
26
31
  my-docs/
27
- ├── index.md
28
- ├── about.md
29
- ├── blog/
30
- │ ├── 2026-01-hello.md
31
- │ └── 2026-03-release.md
32
- ├── logo.png
32
+ ├── content
33
+ │ ├── index.md
34
+ │ ├── about.md
35
+ │ ├── blog/
36
+ │ │ ├── 2026-01-hello.md
37
+ │ │ └── 2026-03-release.md
38
+ │ └── logo.png
33
39
  ├── mdsite.yml # site configuration (created by "mdsite init")
34
40
  ├── package.json # package configuration (created by "mdsite init")
35
41
  ├── package-lock.json # package lock (created by "mdsite init")
@@ -50,7 +56,8 @@ my-docs/
50
56
  └── ...
51
57
  ```
52
58
 
53
- **The benefit:** your source tree is only Markdown files and images — no `node_modules`, no HTML, no build config. `mdsite init` scaffolds nodejs. `mdsite generate` materializes the Nuxt renderer into `.mdsite/`, pre-renders each `.md` to an HTML page, bundles JS/CSS, generates favicons, and writes the whole site ready to upload to any static host (GitHub Pages, Netlify, Cloudflare Pages, S3, etc.).
59
+ > [!NOTE]
60
+ > You can technically mix your content and project files in the same directory, but it's easier to maintain content and generated files separately.
54
61
 
55
62
  ## Install
56
63
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@life-and-dev/mdsite",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "type": "module",
5
5
  "private": false,
6
6
  "description": "Local-first CLI that orchestrates mdsite-nuxt",
@@ -23,12 +23,12 @@
23
23
  },
24
24
  "scripts": {
25
25
  "build": "tsc -p tsconfig.json",
26
- "install-alias": "node scripts/mdsite-dev-alias.js install",
27
- "release:version": "node scripts/release-version.mjs",
28
- "uninstall-alias": "node scripts/mdsite-dev-alias.js uninstall",
29
- "typecheck": "tsc -p tsconfig.json --noEmit",
26
+ "install-alias": "node scripts/mdsite-dev-alias.ts install",
27
+ "release:version": "node scripts/release-version.ts",
28
+ "uninstall-alias": "node scripts/mdsite-dev-alias.ts uninstall",
29
+ "typecheck": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.scripts.json",
30
30
  "test": "vitest run",
31
- "verify:package": "node --experimental-strip-types scripts/verify-package-artifacts.ts",
31
+ "verify:package": "node scripts/verify-package-artifacts.ts",
32
32
  "prepublishOnly": "npm test && npm run typecheck && npm run build && npm run verify:package"
33
33
  },
34
34
  "dependencies": {