mirror of
https://github.com/zed-industries/zed.git
synced 2025-01-01 05:44:17 +00:00
2e8197ce6e
Standardize the blockquote "Notes" usage, so all places are using the `>` blockquote notation, as well as a consistent style for the "Note" word. PS: Thought that bolding the word "**Note**" would make for a higher visual distinction, so went for it in all existing cases! No strong feelings, though; happy to roll back to just "Note:" if that's preferrable! 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.