Inclusive Learning Design Handbook

This project contains the content needed to build and deploy a copy of the Inclusive Design Guide. Please see the
Contributor Guide for information on localizing the content.

Usage

To run locally in development mode

1. Install the required NPM packages: npm install
2. Run Eleventy(link is external) in development mode: npm start.

The website will be available at http://localhost:8080(link is external).

To build and serve using Docker

You can build and serve the website from a Docker(link is external) 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 guide .
• Run the container: docker run --name guide -p 8000:80 guide

The website will be available at http://localhost:8000(link is external)

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

To build for deployment to a personal web server

1. Install the required NPM packages: npm install
2. Run the build script: npm run build
3. Upload the contents of the ./dist/ directory to the web root of your server.

If you make changes to the website, repeat step 2 to build the website and upload any changed files from the ./dist/
directory to the web root of your server.

License Information

The Inclusive Design Guide's code is licensed under the BSD
3-Clause(link is external) license.

The Inclusive Design Guide's content is licensed under the Creative Commons Attribution
3.0(link is external) license.

Language and Menu icons is licensed under the BSD
3-Clause(link is external) license.

OCTOCAT® logo(link is external) used under expressed permissions. GITHUB®, the GITHUB® logo design, OCTOCAT®
and the OCTOCAT® logo design are exclusive trademarks registered in the United States by GitHub, Inc.