mirror of https://github.com/zed-industries/zed.git synced 2024-09-16 00:47:39 +03:00

Marshall Bowers 910963e5f3

This PR updates the docs README with some notes about how to deal with
images.

Release Notes:

- N/A

2024-05-06 11:33:48 -04:00

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.

We have a Cloudflare router called docs-proxythat intercepts requests to zed.dev/docs and forwards them to the "docs" Cloudflare Pages project.
CI uploads a new version to the Pages project from .github/workflows/deploy_docs.yml on every push to main.