@jsnchn/buntastic 0.0.2 → 0.0.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/README.md +18 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -61,6 +61,23 @@ buntastic/
|
|
|
61
61
|
| `buntastic build --drafts` | Build with drafts included |
|
|
62
62
|
| `buntastic dev` | Watch mode + dev server |
|
|
63
63
|
| `buntastic preview` | Serve the built `dist/` folder |
|
|
64
|
+
| `buntastic init` | Initialize a new project (creates files) |
|
|
65
|
+
|
|
66
|
+
## File Structure Safety
|
|
67
|
+
|
|
68
|
+
Buntastic commands interact with your project in different ways:
|
|
69
|
+
|
|
70
|
+
| Command | Modifies Source Files? |
|
|
71
|
+
|---------|----------------------|
|
|
72
|
+
| `build` | No - only creates/updates `dist/` |
|
|
73
|
+
| `build --drafts` | No - only creates/updates `dist/` |
|
|
74
|
+
| `dev` | No - only creates/updates `dist/` |
|
|
75
|
+
| `preview` | No - only reads `dist/` |
|
|
76
|
+
| `init` | **Yes** - creates `content/`, `src/layouts/`, `public/`, and `package.json` |
|
|
77
|
+
|
|
78
|
+
**Safe commands** (`build`, `dev`, `preview`) only read from your source files and output to the `dist/` folder. They will not modify your `content/`, `src/layouts/`, `public/`, or `package.json`.
|
|
79
|
+
|
|
80
|
+
**Destructive command** (`init`) creates new files and **will overwrite** an existing `package.json`. Use this only on new projects or when you want to start fresh.
|
|
64
81
|
|
|
65
82
|
Or with bun run (if using from source):
|
|
66
83
|
|
|
@@ -70,6 +87,7 @@ Or with bun run (if using from source):
|
|
|
70
87
|
| `bun run build:drafts` | Build with drafts included |
|
|
71
88
|
| `bun run dev` | Watch mode + dev server |
|
|
72
89
|
| `bun run preview` | Serve the built `dist/` folder |
|
|
90
|
+
| `bun run init` | Initialize a new project (creates files) |
|
|
73
91
|
|
|
74
92
|
## Writing Content
|
|
75
93
|
|