Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prestashop/docs
PrestaShop technical documentation
https://github.com/prestashop/docs
developer-documentation documentation hacktoberfest service
Last synced: about 9 hours ago
JSON representation
PrestaShop technical documentation
- Host: GitHub
- URL: https://github.com/prestashop/docs
- Owner: PrestaShop
- License: other
- Created: 2016-04-01T15:40:38.000Z (almost 9 years ago)
- Default Branch: 8.x
- Last Pushed: 2024-10-21T20:08:56.000Z (3 months ago)
- Last Synced: 2024-10-29T17:04:09.418Z (3 months ago)
- Topics: developer-documentation, documentation, hacktoberfest, service
- Language: Scala
- Homepage: https://devdocs.prestashop-project.org/
- Size: 55.2 MB
- Stars: 122
- Watchers: 45
- Forks: 480
- Open Issues: 144
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PrestaShop Technical Documentation
[](https://github.com/PrestaShop/docs/actions/workflows/build.yml)
[](https://github.com/PrestaShop/docs/actions/workflows/update-site.yml)
This documentation is available at [https://devdocs.prestashop-project.org/](https://devdocs.prestashop-project.org/)
## Contributing
Contributions are more than welcome! [Find out how](https://devdocs.prestashop-project.org/8/contribute/documentation/how/).
> [!NOTE]
> This repository has specific contribution rules, please [read them](https://github.com/PrestaShop/docs/blob/8.x/.github/CONTRIBUTION_PROCESS.md).
## Rendering the site locally
See https://github.com/PrestaShop/devdocs-site/
## Deployment
The deployment pipeline is documented on the [sources repository for DevDocs](https://github.com/PrestaShop/devdocs-site).
## License
Content from this documentation is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).
## Maintaining Hook list referential
A complete referential of hook and informations on each hook is located in `modules/concepts/hooks/list-of-hooks/`.
This referential can be generated with a script, crawling all:
- PrestaShop (core) codebase
- all native modules
- all native themes
In the documentation, a hook is described in yaml format:
```yaml
---
Title: string #name of the hook
hidden: boolean[true] #must be true
hookTitle: string #title for the description
description: string #description sentence
origin: string #core, module or theme
files:
-
theme: string #theme name only if origin=theme
module: string #module name only if origin=module
url: string #url of the file on github
file: string #path of the file
locations:
- string #back office, front office or both
type: string #action or display
hookAliases:
- string #old hook name or alias
array_return: boolean #true or false if the hook has an `$array_return` parameter set to `true`
check_exceptions: boolean #true or false if the hook has a `$check_exceptions` parameter set to `false`
chain: boolean #true or false if the hook has a `$chain` parameter set to `true`
---
```
This YAML structure enables the shortcode `hookDescriptor` to generate an HTML page with condensed information for documentation, and allows the search script to search within this metadata.
Next, add the shortcode in the page's content:
```
{{% hookDescriptor %}}
```
Finally, if available, add a section with a code example and parameters details:
```
## Parameters details
[...]
## Call of the Hook in the origin file
[...]
```