docs: modify README.

This commit is contained in:
KenanZhu committed 2026-10-12 09:27:33 +08:00
1 parent bcf1b87e82
commit 3d7cf17fb1
2 files changed
+11 -14

No files matched your search

+4 -6
View File
@@ -26,7 +26,7 @@ The gallery shows how the email templates render in the preview tool.
| ![Terminal](docs/images/terminal.png) | **Terminal** | Dark background, monospace fonts and green accents |
| ![Terra](docs/images/terra.png) | **Terra** | Earth tones, terracotta buttons and serif fonts |
Screenshots show only the current default build. Use the [local preview](#preview) to view other email types and languages. See the [screenshot guide](docs/images/README.md) when updating screenshots.
Screenshots show only the current default build. Use the [preview](#preview) to view other email types and languages. See the [screenshot guide](docs/images/README.md) when updating screenshots.
## Installation
@@ -53,7 +53,7 @@ go run . build all
cd ..
```
Building usable templates requires resources from the official Gitea repository to ensure consistent source inputs. The command automatically downloads the official files pinned by `gitea.lock.json`. Subsequent builds use the cached resources without downloading them again. For missing files or a damaged cache, see [official snapshot updates](#official-snapshot-updates).
Building usable templates requires resources from the official Gitea repository to ensure consistent source inputs. The command automatically downloads the official files pinned by `gitea.lock.json`. Subsequent builds use the cached resources without downloading them again.
### Install a Theme
@@ -110,7 +110,7 @@ go run . dev
cd ..
```
Open [http://127.0.0.1:3456](http://127.0.0.1:3456). The Go server watches theme files, the shared framework, the lock file and cache, and preview test data. When a file changes, it rebuilds the email templates and refreshes the page through server-sent events (SSE) to provide live reload.
Open [http://127.0.0.1:3456](http://127.0.0.1:3456). The server watches theme files, the shared framework, the lock file and cache, and preview test data. When a file changes, it rebuilds the email templates and refreshes the page through server-sent events (SSE) to provide live reload.
### Controls and Keyboard Shortcuts
@@ -138,7 +138,6 @@ The project is organized around a shared framework, theme styles and build tools
```text
.github/ # Workflows and maintenance scripts
release-notes/ # Release notes for each version
scripts/ # Documentation updates, packaging and Gitea release scripts
workflows/ # Validation and publication
docs/ # Chinese documentation, documentation index and gallery images
@@ -155,7 +154,6 @@ tools/ # Go CLI, build tools and tests
preview/ # Email rendering, locale adaptation and development server
upstream/ # Official snapshot downloads, verification and translation key discovery
gitea.lock.json # Official version tag, commit and file checksums
README.md
```
Official templates provide notification content, conditions, subject lines and links. The shared framework handles email presentation, while themes use metadata and CSS to select layouts and define styles. Theme directories do not contain official email source files or translations.
@@ -196,7 +194,7 @@ Gitea currently includes the following 11 email templates [1](#notes):
## Contributing
Contributions to themes, tools, documentation and translations are welcome. The [contributor guide](CONTRIBUTING.md) covers local environment setup, design guidelines, required checks and the release process.
Contributions to themes, tools, documentation and translations are welcome. See the [contributor guide](CONTRIBUTING.md) for details on contributing.
## License