The public user guide repository for the ExpressionEngine project. The online version of the user guide is hosted at docs.expressionengine.com.
The ExpressionEngine user guide is written in human-readable Markdown and uses a simple script to generate beautiful HTML docs.
Building the docs requires Node and npm (latest stable version).
In the root of the repository, install all the dependencies:
npm install
To build the docs:
npm run build
To dynamically rebuild on any file changes:
npm run watch
The documentation css and js files are located under theme/assets-src.
To build the theme assets, run npm run buildAssets. You can also dynamically rebuild the assets when a file changes: npm run watchAssets.
Manually load /build/index.html in your browser to view your local build. For example, file:///Users/<username>/Documents/ExpressionEngine-User-Guide/build/index.html. You can use the side navigation to navigate to different local files, but the search functionality always takes you to the live version at docs.expressionengine.com.
See something that needs fixing? Want to improve the user guide or make it more helpful? Great! Check out CONTRIBUTING.md for details.
The ExpressionEngine project is copyright (c) 2003-2021 Packet Tide, LLC. (https://packettide.com) and is licensed under Apache License, Version 2.0. This project contains subcomponents with separate copyright and license terms, all of which are fully FOSS and compatible with Apache-2.0.
Complete license terms and copyright information can be found in LICENSE.txt in the root of this repository.
"ExpressionEngine" is a registered trademark of Packet Tide, LLC. in the United States and around the world. Refer to ExpressionEngine's Trademark Use Policy for access to logos and acceptable use.