www/README.md

70 lines
1.6 KiB
Markdown
Raw Normal View History

2022-06-08 02:22:17 +03:00
![tea](https://tea.xyz/banner.png)
2022-03-23 07:04:33 +03:00
2022-07-07 23:18:49 +03:00
Deploys to [tea.xyz].
2022-03-25 16:50:26 +03:00
2022-06-08 02:22:17 +03:00
2022-07-07 23:18:49 +03:00
# Legal
2022-03-25 16:50:26 +03:00
2022-07-07 23:18:49 +03:00
You may not publish this website in an attempt to masquerade as tea.inc.
The tea logo and wordmark are registered trademarks of tea.inc.
2022-05-04 22:11:49 +03:00
2022-06-08 02:22:17 +03:00
2022-07-07 23:18:49 +03:00
# Contributing
2022-05-04 22:11:49 +03:00
2022-07-07 23:18:49 +03:00
* The site is built with [Hugo] and [Bootstrap].
* `.html` files in [`./src/layouts/page/`] have a corresponding `.md` file in [`./src/content/`].
* Repeated components are in [`./src/layouts/partials/`].
2022-05-04 22:11:49 +03:00
2022-07-07 23:18:49 +03:00
## Getting Started
2022-11-08 19:10:35 +03:00
hugo can render your edits while you work:
```sh
2022-11-08 19:10:35 +03:00
hugo serve --watch --buildDrafts --source src
# or
just serve
```
2022-11-08 19:10:35 +03:00
## Package Pages
2022-05-04 22:11:49 +03:00
2022-11-08 19:10:35 +03:00
The detail pages of each package are not committed to the repository for the
simple reason of that would be too much repeating data.
Execute the following command just once per version of
`/src/data/packages.json`. This will create the package detail pages in
`/src/content/+[package.full_name].md`.
Which resembles the installation tag in tea cli
2022-07-07 23:18:49 +03:00
```sh
.github/build-package-pages.sh src/data/packages.json src/content
# or
just package-pages
2022-07-07 23:18:49 +03:00
```
2022-07-07 23:18:49 +03:00
## Dependencies
| Project | Version |
|--------------|---------|
| gohugo.io | >=0.99 |
2023-02-02 04:12:26 +03:00
| nodejs.org | =18.13.0 |
| npmjs.com | * |
| just.systems | ~1 |
2022-11-01 16:10:54 +03:00
2022-07-07 23:18:49 +03:00
# Build
2022-07-07 23:18:49 +03:00
Builds a static, deployable version of the website.
2022-07-07 23:18:49 +03:00
```sh
2022-11-10 05:45:40 +03:00
npm ci
2022-07-07 23:18:49 +03:00
hugo --source src --destination ../public --minify
# or
just build
2022-07-07 23:18:49 +03:00
```
2022-07-07 23:18:49 +03:00
[tea.xyz]: https://tea.xyz
2022-06-08 02:22:17 +03:00
[Bootstrap]: https://getbootstrap.com/docs/5.2/getting-started/introduction/
2022-07-07 23:18:49 +03:00
[Hugo]: https://gohugo.io/documentation/
[`./src/layouts/page/`]: src/layouts/page
[`./src/content/`]: src/content
[`./src/layouts/partials/`]: src/layouts/partials