Create a complete sample project. quickstart is meant for first-time evaluation and for spinning up a demo repository quickly.
mdpress quickstart [directory] [flags]| Argument | Required | Description |
|---|---|---|
[directory] |
No | Target directory. The default is my-book. |
quickstart currently has no dedicated flags. It supports the standard logging flags:
| Flag | Default | Description |
|---|---|---|
-v, --verbose |
off | Print detailed logs. |
-q, --quiet |
off | Print errors only. |
The current implementation generates:
book.yamlREADME.mdpreface.mdchapter01/README.mdchapter02/README.mdchapter03/README.mdimages/README.mdimages/cover.svg
After generation, the project can be built and previewed immediately.
mdpress quickstart
mdpress quickstart my-book
mdpress quickstart ./examples/demo-bookcd my-book
mdpress build --format html
mdpress serve- If the target directory already exists and is not empty, the command refuses to write, to avoid overwriting user files.
- If the target directory already exists but is empty, the current implementation allows writing.
quickstartis for creating a demo project. It does not scan your existing Markdown content; usemdpress initfor that.--configappears in global flags, butquickstartdoes not use it.