Infusion Documentation

Browse the Infusion Documentation

You can browse the Infusion Documentation website, or if you prefer, you can browse the source documentation files directly on GitHub.

Working with the Infusion Documentation locally

You must have Node and NPM installed in order to work on the Infusion Documentation locally (the LTS version is recommended).

To install the dependencies for this project:

npm install

To serve the site locally in development mode with live reloading using Eleventy:

npm run start

Then, point your browser to: http://localhost:8080/

To statically build the site using Eleventy:

npm run build

Deploying the Infusion Documentation website

The Infusion Documentation website is published with Netlify every time new content is pushed to the main branch of this repository. Deploy previews are also generated for every pull request. For more information, please review Netlify's documentation.

Generating a Docker image

You can serve the website from a Docker container.

Once you have Docker installed, run the following commands to build a Docker image and start a container:

• Build the image: docker build -t infusion-docs .
• Run the container: docker run --name infusion-docs -p 8000:80 infusion-docs

The documentation will be available at http://localhost:8000

• To stop and remove the container: docker rm -f infusion-docs

If you make changes to the documentation, repeat the steps to build the image and start a new container.

3rd party software included

MIT License

• Heroicons v2.1.1