https://github.com/thelia/docs
Github repository for Thelia documentation
https://github.com/thelia/docs
documentation docusaurus thelia
Last synced: about 1 year ago
JSON representation
Github repository for Thelia documentation
- Host: GitHub
- URL: https://github.com/thelia/docs
- Owner: thelia
- License: gpl-3.0
- Created: 2022-05-30T11:58:21.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T14:08:33.000Z (over 1 year ago)
- Last Synced: 2025-04-26T17:05:07.431Z (about 1 year ago)
- Topics: documentation, docusaurus, thelia
- Language: JavaScript
- Homepage: https://doc.thelia.net
- Size: 7.29 MB
- Stars: 0
- Watchers: 8
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Installation
```console
yarn install
```
## Local Development
```console
yarn start
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
## Build
```console
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
```console
GIT_USER= USE_SSH=true yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
## Automatic generation
The hooks, events and commands doc can be generated with the open source script: [AutoDocThelia](https://github.com/mathisdlg/AutoDocThelia/).