mixa/zed

Files

Marshall Bowers b34ab6f3a1 Remove references to submodules (#11673 )

This PR removes the references to initializing Git submodules as part of
building Zed.

These are no longer needed, as our only submodule was removed in #11672.

Release Notes:

- N/A

2024-05-10 14:33:53 -04:00

src

Remove references to submodules (#11673 )

2024-05-10 14:33:53 -04:00

theme

docs: Fix copying code blocks (#11617 )

2024-05-09 11:52:26 -04:00

.gitignore

Setup docs deployments with mdBook (#11369 )

2024-05-03 15:52:15 -04:00

book.toml

docs: Change path from /docs2 to /docs (#11436 )

2024-05-06 10:51:37 -04:00

README.md

docs: Update README (#11442 )

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

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 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.