Code Monkey home page Code Monkey logo

docs's Introduction

PrestaShop Technical Documentation

Build

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.

docs's People

Contributors

boubkerbribri avatar d-roduit avatar djodjo3 avatar eternoendless avatar gadnis avatar jevgenijvisockij avatar jf-viguier avatar jolelievre avatar jorgevrgs avatar klemart3d avatar kpodemski avatar ksaandev avatar likemusic avatar luigimassa avatar matks avatar matthieu-rolland avatar mickaelandrieu avatar moncef-essid avatar pfortune avatar pierrerambaud avatar progi1984 avatar pululuk avatar quetzacoalt91 avatar sarjon avatar tdavidsonas88 avatar tomas862 avatar touxten avatar ttoine avatar zalexki avatar zuk3975 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.