Repository files navigation

The public user guide repository for theExpressionEngine project. The online version of the user guide is hosted atdocs.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 undertheme/assets-src.

To build the theme assets, runnpm run buildAssets. You can also dynamically rebuild the assets when a file changes:npm run watchAssets.

There are 2 options for viewing your local changes.

1. Runnpx http-server -o which should make the site available athttp://127.0.0.1:8080/build/.
2. Manually view any HTML file in/build/ in your browser. For example,file:///Users/<username>/Documents/ExpressionEngine-User-Guide/build/index.html to view the home page.

You can use the side navigation to navigate to different local files, but the search functionality takes you to the live version athttps://docs.expressionengine.com unless you follow the steps atUsing DocSearch Locally.

First you will need to choose a docsearch index name to use for your local testing and set that inconfig.yml

Then you will need to build the docs and serve a local copy. For simplicity's sake we recommend using the node http-server like thisnpx http-server -o

Next you will need to update all the urls insearch.config.json to point at your local copy of the documentation. Do a find/replace onhttps://docs.expressionengine.com/latest =>http://localhost:8080. You will also need to update theallowed_domains array to include this new url. (If you are on a mac you may need to usehttp://host.docker.internal:8080 instead so that the scraper container can connect to the docs on your local http-server.)

Finally you can scrape your local docs with the following docker command

docker run -t --rm --network=host \    -e MEILISEARCH_HOST_URL=https://docsearch.expressionengine.com \    -e MEILISEARCH_API_KEY={{ SECRET_KEY }} \    -v ./search.config.json:/docs-scraper/search.config.json \    getmeili/docs-scraper:latest pipenv run ./docs_scraper search.config.json

See something that needs fixing? Want to improve the user guide or make it more helpful? Great! Check outCONTRIBUTING.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 inLICENSE.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'sTrademark Use Policy for access to logos and acceptable use.