Skip to content
PrestaShop technical documentation
CSS HTML JavaScript Scala Shell
Branch: master
Clone or download

Latest commit

matks Merge pull request #542 from matks/warning-api-htaccess
Add notice warning for webservice usage
Latest commit 9b66cf4 May 26, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Update Hugo version Oct 31, 2019
src Merge pull request #542 from matks/warning-api-htaccess May 26, 2020
.gitignore Remove main.js & main.js.map Feb 10, 2020
.travis.yml Update travis script Aug 8, 2018
LICENSE Add license Jun 20, 2018
README.md Replace http with https for README urls Apr 30, 2020

README.md

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

Prerequisites

Hugo

TL;DR:

  • Linux: ./bin/installHugo.sh
  • Mac: brew install hugo
  • Windows: Grab the release binary

Or read the Official install guide.

Node.js and NPM

This is only needed if you want to customize the style.

Download Node here

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 and Webpack for bundling.

Source files for the main css are in this directory:

src/themes/hugo-theme-learn/_src/sass

How to build the theme

  1. Switch to the theme's _src folder

    cd src/themes/hugo-theme-learn/_src
    
  2. Install NPM dependencies (only the first time)

    npm install
    
  3. Launch build

    npm run build
    

License

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

You can’t perform that action at this time.