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
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.
Clone the repository somewhere on your system
git clone https://github.com/PrestaShop/docs.git
Launching the site
-
Switch to the
src
directory:cd /path/to/docs/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.
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
-
Switch to the theme's
_src
foldercd src/themes/hugo-theme-learn/_src
-
Install NPM dependencies (only the first time)
npm install
-
Launch build
npm run build
License
Content from this documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.