Chloroplast

Wilderness Labs docs engine that converts and hosts Markdown and (soon) XML API docs into HTML. You can read the docs here:
https://wildernesslabs.github.io/Chloroplast/

Getting Started

First Install the choloroplast.tool dotnet tool.

Then run the following commands to: create a new Chloroplast project at targetFolder, then build it, and run the local Chloroplast webserver to preview the docs.

chloroplast new conceptual targetFolder

cd targetFolder

chloroplast build
chloroplast host

Once you're done with that, you can modify that default template, and read the docs.

Local testing without BasePath

If your SiteConfig.yml declares a basePath (common for GitHub Pages) but you'd like to preview locally at the root (/) without rewriting links, pass the --no-basepath flag to build or host:

chloroplast build --no-basepath
chloroplast host --no-basepath

The provided PowerShell helper scripts also support this via a switch:

./scripts/build.ps1 -NoBasePath
./scripts/host.ps1 -NoBasePath

This does not modify your configuration, it only suppresses base path application for that single run.

Host the Chloroplast docs

If you want to see Chloroplast in action, you can even host the Chloroplast docs themselves.

1. Clone the Chloroplast repo.

   git clone https://github.com/WildernessLabs/Chloroplast.git
   cd Chloroplast
   

2. Install Chloroplast.

   There are several ways to install Chloroplast. This will install it from NuGet as a global tool.

   dotnet tool install Chloroplast.Tool -g
   

3. Navigate to the Chloroplast docs.

   cd docs
   

4. Build and host the docs.

   chloroplast build
   chloroplast host
   

   This will build and then start hosting the docs from localhost:5000, launching a browser to preview them.