https://github.com/gatewayd-io/docs
GatewayD docs
https://github.com/gatewayd-io/docs
documentation gatewayd
Last synced: 5 months ago
JSON representation
GatewayD docs
- Host: GitHub
- URL: https://github.com/gatewayd-io/docs
- Owner: gatewayd-io
- License: agpl-3.0
- Created: 2022-10-16T11:38:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-09-03T20:18:58.000Z (10 months ago)
- Last Synced: 2025-09-03T22:10:18.933Z (10 months ago)
- Topics: documentation, gatewayd
- Language: Ruby
- Homepage: https://docs.gatewayd.io/
- Size: 1.33 MB
- Stars: 16
- Watchers: 1
- Forks: 6
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
GatewayD Documentation
The source code and markdown files for the GatewayD documentation
> [!IMPORTANT]
> The pre-commit hook is used to update the `last_modified_date` field in the frontmatter for each page. It will run automatically upon committing changes if you run the following commands to enable them:
>
> ```bash
> ln .git/hooks/pre-commit .githooks/pre-commit/01-update-last-modified-date
> git config core.hooksPath .githooks
> ```
## Running the docs locally
The docs are built using [Jekyll](https://jekyllrb.com/) and the [just-the-docs](https://just-the-docs.github.io/just-the-docs/) theme. To run the docs locally, you need to have Git and Ruby installed. Then, install Jekyll and `bundler`:
```bash
gem install jekyll bundler
```
Then, install the dependencies:
```bash
bundle install
```
Finally, run the docs:
```bash
bundle exec jekyll serve
```
If you want to clean the build directory, run:
```bash
bundle exec jekyll clean
```
## GitHub Releases Tag
The GitHub Releases Tag is a special tag that is used to retrieve the latest tag name for a repository on GitHub. It is used to display the latest version of GatewayD in the docs. To update the tags in the docs, just rebuild the docs locally and push the changes to the `main` branch. The GitHub Releases Tag will be updated automatically.
To use the tag in the docs, use the following Liquid tag:
```liquid
{% github_latest_release gatewayd-io/gatewayd v %}
```
The first parameter is the repository name in the format `owner/repo`. The second parameter is used to remove the prefix of the tag name. For example, if the tag name is `v1.0.0`, the second parameter will remove the `v` prefix and display only `1.0.0`. If omitted, the tag name will be displayed as is, including the prefix.
For private repositories, you can set the `GITHUB_TOKEN` environment variable with a [personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) to authenticate with GitHub. If the token is not provided, the tag will be displayed as `unknown`.
The tag can be used multiple times in the same page. A single request will be made to the GitHub API to retrieve the latest tag name for each repository.
## Contributing
We welcome contributions from everyone. Just open an [issue](https://github.com/gatewayd-io/docs/issues) or send us a [pull request](https://github.com/gatewayd-io/docs/pulls).
## License
GatewayD is licensed under the [Affero General Public License v3.0](https://github.com/gatewayd-io/docs/blob/main/LICENSE).