PrestaShop technical documentation
CSS JavaScript HTML Scala
Switch branches/tags
Nothing to show
Clone or download
Latest commit 5e4ed9b Jul 13, 2018
Permalink
Failed to load latest commit information.
bin/hugo-0.41 Update Hugo to 0.41 Jun 7, 2018
src Fix link Jul 13, 2018
.gitignore Move css to sass Feb 14, 2018
.travis.yml Change build branch Jun 20, 2018
LICENSE Add license Jun 20, 2018
README.md Update readme Jun 20, 2018

README.md

PrestaShop Technical Documentation

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

Contributing

Contributions are more than welcome! Find out how.

Rendering the site locally

Prerequisites

Hugo

Install guide: https://gohugo.io/getting-started/installing

TL;DR:

  • Linux: Use the binary in the /bin directory
  • Mac: brew install hugo
  • Windows: Grab the release binary

Node.js and NPM

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

Download Node here

Launching the site

  1. Switch to the src directory:

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