https://github.com/sheeep/contao-docs
https://github.com/sheeep/contao-docs
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/sheeep/contao-docs
- Owner: sheeep
- License: other
- Created: 2019-02-18T14:19:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-18T17:01:44.000Z (over 7 years ago)
- Last Synced: 2024-10-19T09:03:56.844Z (over 1 year ago)
- Language: CSS
- Size: 8.23 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Contao Documentation
The documentation for the Contao project will be maintained in this repository.
## Build
```
make build
```
Builds the entire documentation into the `build` directory using the [Hugo site generator](https://gohugo.io/commands/hugo/).
```
make dev
```
Spins up the development server which automatically tracks changes in the `docs` directory and rebuilds the frontend.
You can access the frontend on [http://localhost:1313](http://localhost:1313).
```
make clean
```
Cleans the build directory.
## Licence
The Contao documentation is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
License](https://creativecommons.org/licenses/by-nc-sa/4.0/) license (CC BY-NC-SA 4.0). If you want to redistribute a modified or unmodified version of the documentation, you can do so under the license terms.
If you contribute to the documentation, e.g. by creating pull requests, you grant us full usage rights of any content you create or upload. You also ensure that your
content does not violate any third-party rights.
We are not claiming exclusive usage rights, therefore you are free to use your
contributed content (e.g. texts or images) in any other project as well.