mirror of
https://github.com/zed-industries/zed.git
synced 2025-01-01 05:44:17 +00:00
5213f6207d
Mostly tiny stuff. Quick run-down of the changes: - Using `*Note*` instead of `NOTE` for the blockquote callouts (piggybacking from https://github.com/zed-industries/zed/pull/11724) - Use hyphens for bullet lists instead of asterisks - Capitalize every (applicable) mention to Zed - Capitalize mentions of other products (e.g., google cloud → Google Cloud) - Swap e.g. → for example — for clarity (latinisms may be unfamiliar for some non-native English speakers, surprisingly!) Release Notes: N/A |
||
|---|---|---|
| .. | ||
| src | ||
| theme | ||
| .gitignore | ||
| book.toml | ||
| README.md | ||
Zed Docs
Welcome to Zed's documentation.
This is built on push to main and published automatically to https://zed.dev/docs.
To preview the docs locally you will need to install mdBook, and then run:
mdbook serve docs
Images and videos
To add images or videos to the docs, upload them to another location (e.g., zed.dev, GitHub's asset storage) and then link out to them from the docs.
Putting binary assets such as images in the Git repository will bloat the repository size over time.
Internal notes:
- We have a Cloudflare router called
docs-proxythat intercepts requests tozed.dev/docsand forwards them to the "docs" Cloudflare Pages project. - CI uploads a new version to the Pages project from
.github/workflows/deploy_docs.ymlon every push tomain.