Skip to content

Commit 31dafec

Browse files
committed
Update README
1 parent 57b75c0 commit 31dafec

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@
1212
<a href="https://docs.gatewayd.io/">Documentation</a>
1313
</p>
1414

15+
> [!Latest modified date]
16+
> 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:
17+
>
18+
> ```bash
19+
> ln .git/hooks/pre-commit .githooks/pre-commit/01-update-last-modified-date
20+
> git config core.hooksPath .githooks
21+
> ```
22+
1523
## Running the docs locally
1624
1725
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`:
@@ -53,11 +61,3 @@ The first parameter is the repository name in the format `owner/repo`. The secon
5361
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`.
5462

5563
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.
56-
57-
## Latest modified date
58-
59-
The `generate_last_modified_data.sh` script is used to generate the `last_modified_date` data in the frontmatter for each page. It should be run manually before pushing the changes to the `main` branch.
60-
61-
```bash
62-
./generate_last_modified_data.sh
63-
```

0 commit comments

Comments
 (0)