v0.1.0 - initial release (#1)
Reviewed-on: #1
This commit was merged in pull request #1.
This commit is contained in:
43
README.md
43
README.md
@@ -78,13 +78,13 @@ State is stored separately (created on first successful apply):
|
||||
|
||||
## Usage
|
||||
|
||||
Dry-run evaluation:
|
||||
Dry-run validation:
|
||||
|
||||
```bash
|
||||
wp-materialize evaluate
|
||||
wp-materialize validate
|
||||
```
|
||||
|
||||
Apply (evaluate, then materialize):
|
||||
Apply (validate, then materialize):
|
||||
|
||||
```bash
|
||||
wp-materialize apply
|
||||
@@ -96,6 +96,36 @@ Skip git sync:
|
||||
wp-materialize apply --no-sync
|
||||
```
|
||||
|
||||
Local export (writes per-post directories with HTML, metadata, and WP command):
|
||||
|
||||
```bash
|
||||
wp-materialize local /path/to/output
|
||||
```
|
||||
|
||||
Notes:
|
||||
1. The local export assumes every post is new and generates create commands.
|
||||
2. The local export does not call WordPress or resolve category IDs.
|
||||
|
||||
Create placeholder config or manifest:
|
||||
|
||||
```bash
|
||||
wp-materialize new --config
|
||||
wp-materialize new --config /path/to/config.json
|
||||
wp-materialize new --manifest /path/to/content
|
||||
```
|
||||
|
||||
Add files or subdirectories to a manifest (no evaluation):
|
||||
|
||||
```bash
|
||||
wp-materialize add-file /path/to/content/post.md
|
||||
wp-materialize add-file /path/to/content/post.md /path/to/content
|
||||
wp-materialize add-file /path/to/content/post.md --current
|
||||
|
||||
wp-materialize add-subdir /path/to/content/notes
|
||||
wp-materialize add-subdir /path/to/content/notes /path/to/content
|
||||
wp-materialize add-subdir /path/to/content/notes --current
|
||||
```
|
||||
|
||||
## Manifests
|
||||
|
||||
Each managed directory must contain a `.wp-materialize.json` manifest. See `configurations.md` for the manifest guide.
|
||||
@@ -105,6 +135,13 @@ Each managed directory must contain a `.wp-materialize.json` manifest. See `conf
|
||||
1. Python 3.10+
|
||||
2. Packages:
|
||||
- `Markdown>=3.6`
|
||||
- `py_gfm` (only required when using `renderer: "py-gfm"`)
|
||||
|
||||
## System Prerequisites
|
||||
|
||||
1. `wp` CLI must be installed and available in PATH for `apply`.
|
||||
2. `local` does not require `wp`.
|
||||
3. `pandoc` must be installed and available in PATH when using `renderer: "pandoc"`.
|
||||
|
||||
Install dependencies:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user