Skip to content
main
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Infusion Documentation

Netlify Status

Browse the Infusion Documentation on GitHub

You can browse the Infusion Documentation as static user friendly pages, or if you prefer, you can browse the Infusion Documentation directly on GitHub.

Building a Local Copy of the Documentation

Get the node modules for this project:

npm install

To generate the HTML and run the DocPad server locally:

npm run docpad

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

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.

Deploy

While GitHub Pages is not used to host fluidproject.org, our deployment process requires that the generated site be pushed to the deploy branch in the project repo. The contents of the deploy branch will automatically be served as the contents are changed.

To generate and push to the deploy branch on the project repo run the following:

npm run deploy

WARNING: Deploying will upload the site to the deploy branch of the origin remote. If you have cloned from the production repository and you have push access, you will actually run the docs publication workflow against the live production branch, regardless of whichever branch you happen to be working on.

A Note on DocPad plugins

Changes to DocPad plugins used by this package only take effect when your node_modules directory is up to date. It is therefore highly important to remove your existing node_modules and rerun npm install when pulling down updates to this repository. Failure to do so may result in broken links, rendering errors, and other problems.

Note also that the plugins used by this package are only compatible with DocPad 6.79.4 or earlier. You should use the version of docpad installed as a dependency of this package rather than a globally installed version. This is handled automatically by the npm run commands mentioned in the rest of this document.

You can’t perform that action at this time.