zed-industries/zed
1
1
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2024-07-08 19:47:07 +03:00
Code Issues Packages Projects Releases Wiki Activity
main
zed/docs
History
Zhangfan 1bd585186a
docs: Update the example to set up black formatter in Python (#13839) 
As titled. The new example is consistent with the instructions in
"Configuring Zed". I verified that the example works as expected.

Release Notes:

- Update the instructions to set up external formatter for Python.
2024-07-05 15:32:48 +02:00
..
src docs: Update the example to set up black formatter in Python (#13839) 2024-07-05 15:32:48 +02: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.