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.
- Install the required NPM packages:
npm install - Run Eleventy in development mode:
npm start.
The website will be available at http://localhost:8080.
You can build and 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 guide . - Run the container:
docker run --name guide -p 8000:80 guide
The website will be available at http://localhost:8000
If you make changes to the website, repeat the steps to build the image and start a new container.
- Install the required NPM packages:
npm install - Run the build script:
npm run build - 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.
The Inclusive Design Guide's code is licensed under the BSD 3-Clause license.
The Inclusive Design Guide's content is licensed under the Creative Commons Attribution 3.0 license.
Language and Menu icons is licensed under the BSD 3-Clause license.
OCTOCAT® logo 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.