mirror of
https://github.com/ivabus/www
synced 2024-11-29 19:15:05 +03:00
69 lines
1.6 KiB
Markdown
69 lines
1.6 KiB
Markdown
|
|
|
|
Deploys to [tea.xyz].
|
|
|
|
|
|
# Legal
|
|
|
|
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.
|
|
|
|
|
|
# Contributing
|
|
|
|
* 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/`].
|
|
|
|
## Getting Started
|
|
|
|
hugo can render your edits while you work:
|
|
|
|
```sh
|
|
hugo serve --watch --buildDrafts --source src
|
|
# or
|
|
just serve
|
|
```
|
|
|
|
## Package Pages
|
|
|
|
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
|
|
|
|
```sh
|
|
.github/build-package-pages.sh src/data/packages.json src/content
|
|
# or
|
|
just package-pages
|
|
```
|
|
|
|
## Dependencies
|
|
|
|
| Project | Version |
|
|
|--------------|---------|
|
|
| gohugo.io | >=0.99 |
|
|
| nodejs.org | >=14 |
|
|
| npmjs.com | * |
|
|
| just.systems | ~1 |
|
|
|
|
# Build
|
|
|
|
Builds a static, deployable version of the website.
|
|
|
|
```sh
|
|
npm ci
|
|
hugo --source src --destination ../public --minify
|
|
# or
|
|
just build
|
|
```
|
|
|
|
|
|
[tea.xyz]: https://tea.xyz
|
|
[Bootstrap]: https://getbootstrap.com/docs/5.2/getting-started/introduction/
|
|
[Hugo]: https://gohugo.io/documentation/
|
|
[`./src/layouts/page/`]: src/layouts/page
|
|
[`./src/content/`]: src/content
|
|
[`./src/layouts/partials/`]: src/layouts/partials
|