This repository contains the files needed to build a copy of the Fluid Project website.

This is not an immediately deployable version of the website - docpad is used to build the site from source files.

1. Get the required node modules: npm install
2. Run docpad from the fluid-website directory npm run docpad.
3. Open http://localhost:9778/ to see the website.

1. Start by working from a clone of the repository you want to deploy to. This step is important, otherwise your output may deploy to the wrong location.
2. Deploy to gh-pages, run: npm run deploy. By doing this, docpad will generate the site to the
   remote gh-pages branch.

1. Run: npm run generate
2. Copy the contents of ./out/ directory to your server.

• Modifications can be done to any source file or directory except for the contents of the out/ directory. The out directory and its contents are not to be versioned since it contains the generated output made by docpad from the source files and are overwritten.
• The 404 error page will only appear when deployed to the root of a gh-pages domain or gh-pages custom domain. It will not appear when deployed locally or when deployed through a gh-pages (sub) project. To test the 404 error page, either load the 404.html directly in a browser, or deploy to the root of a gh-pages domain.

The following plugins are used in this website. They a provided here as a reference:

• docpad installed - https://docpad.org/
• docpad handlebars plugin - https://github.com/docpad/docpad-plugin-handlebars/
• moment plugin - https://www.npmjs.org/package/docpad-plugin-moment
• markdown plugin - https://github.com/docpad/docpad-plugin-marked
• stylus plugin - https://www.npmjs.org/package/docpad-plugin-stylus
• eco plugin - https://github.com/docpad/docpad-plugin-eco
• gh-pages plugin - https://github.com/docpad/docpad-plugin-ghpages
• redirector plugin - https://www.npmjs.org/package/docpad-plugin-redirector

The Fluid Project website is available under Creative Commons Attribution License.