Version: v. 1

Spark doc

spark-doc - Generate documentation for Ylem source files.

spark doc [options]

Generates and builds an mdbook from Ylem source files.

--root path
The project's root path. By default, this is the root directory of the current git repository, or the current working directory.

--out path The output path for the generated mdbook. By default, it is the docs/ in project root.

--build Build the mdbook from generated files.

--serve Serve the documentation locally.

--hostname hostname Hostname for serving documentation. Requires --serve.

--port port Port for serving documentation. Requires --serve.

-h
--help
Prints help information.

Generate documentation.
```
spark doc
```
Generate and build documentation with specified output directory.
```
spark doc --build --out ./documentation
```
Generate and serve documentation locally on port 4000.
```
spark doc --serve --port 4000
```