yildizib / docs

PrestaShop technical documentation

PrestaShop Technical Documentation

This documentation is available at https://devdocs.prestashop.com/

Contributing

Contributions are more than welcome! Find out how.

Rendering the site locally

Using docker-compose

1. Clone the repository somewhere on your system:

   git clone https://github.com/PrestaShop/docs.git
   

2. Switch to the docs directory:

   cd docs
   

3. Create .env file by .env.example:

   cp .env.example .env
   

4. Launch Hugo service:

   docker-compose up hugo
   

Natively

Setting up your environment

1. Install Hugo. You will need v0.82+ (extended binary)

   • Mac and Linux: Run ./bin/installHugo.sh
   • Windows: Grab the release binary

   Or read the Official install guide.

2. Clone the repository somewhere on your system

   git clone https://github.com/PrestaShop/docs.git
   

Launching the site

1. Switch to the src directory:

   cd /path/to/docs/src
   

2. Launch Hugo:

   hugo server
   

   You may need to change the path to the hugo binary depending on where it is on your system

3. 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.

Customizing the style

We use Sass for styling, bundled by Hugo itself.

The source files for the main css & js are in this directory:

src/themes/hugo-theme-learn/assets

License

Content from this documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.