This repository contains the sources to build DevDocs - PrestaShop's technical documentation site.
docker compose
Clone the repository somewhere on your system:
git clone --recurse-submodules https://github.com/PrestaShop/devdocs-site.git
Switch to the devdocs-site
directory:
cd devdocs-site
Create .env
file by .env.example
:
cp .env.example .env
Launch Hugo service:
docker compose up hugo
You can access to the devdocs site at http://localhost:1313
Install Hugo. You will need v0.121+ (extended binary)
./bin/installHugo.sh
Or read the Official install guide.
Clone the repository somewhere on your system
git clone --recurse-submodules https://github.com/PrestaShop/devdocs-site.git
Switch to the src
directory:
cd /path/to/devdocs-site/src
Launch Hugo:
hugo server
You may need to change the path to the
hugo
binary depending on where it is on your system
Done! You can open up the site on your browser.
It's usually available at http://localhost:1313
Any change you perform on your data will be updated almost instantly.
We use Sass for styling, bundled by Hugo itself.
The source files for the main css & js are in the assets
directory of the theme's repository.
Every time a contribution is merged inside one of the docs branches, a first GitHub workflow will notify the Sources repository.
Upon being notified, a second GitHub workflow is triggered in devdocs-site, which updates its submodules and commits them.
This commit triggers a third GitHub workflow that will deploy the latest version to devdocs.prestashop-project.org .
Theme updates do not trigger a deployment, consequently following a theme update, the docs website must be deployed manually.
Content from this documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.