Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terminal42/extensions-docs
https://github.com/terminal42/extensions-docs
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/terminal42/extensions-docs
- Owner: terminal42
- License: other
- Created: 2023-11-23T13:16:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-10T12:58:26.000Z (27 days ago)
- Last Synced: 2024-12-10T13:41:59.486Z (27 days ago)
- Language: CSS
- Size: 54.7 MB
- Stars: 0
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# terminal42 extensions documentation framework
This repository holds the documentation books hosted on https://extensions.terminal42.ch/docs. It contains documentation
for both, commercial as well as free extensions. Feel free to contribute to whichever you like :-)## Cloning
The project installs the Hugo Learn theme as a git submodule. Thus, when cloning
the repository, you need to use the `--recurse-submodules` parameter:```bash
git clone --recurse-submodules [email protected]:terminal42/extensions-docs.git
```## Updating the Theme
To update the theme after cloning, simply run the following command:
```bash
git submodule foreach git pull origin master
```## Build
The documentation is built using the [Hugo site generator](https://gohugo.io/),
thus you need to [install Hugo](https://gohugo.io/getting-started/installing/)
first on your system.Building is done using a PHP file. There are different commands available
depending on what part of the documentation you want to build.```
./book build-
```Builds the entire documentation into the `build` directory.
```
./book live-
```Spins up the development server which automatically tracks changes in the `docs`
directory and rebuilds the front end. You can access the front end on [http://localhost:1313](http://localhost:1313).