mirror of
https://github.com/zed-industries/zed.git
synced 2024-12-29 12:38:02 +00:00
5c0d800b21
This PR allows configuring the intensity of code fade applied to unused code (relates to #4785). _Note: Right now I included it as a top level config which might be a little out of place (but is easiest to instrument). Open for suggestions on where else it would be better suited for._ _Note 2: I am unfamiliar with the codebase. Feel free to either close this PR and re-implement in a better way or suggest high level changes if I'm approaching anything wrong :)._ Release Notes: - Added `unnecesary_code_fade` setting to control how strongly to fade unused code. --------- Co-authored-by: Marshall Bowers <elliott.codes@gmail.com> |
||
|---|---|---|
| .. | ||
| src | ||
| theme | ||
| .gitignore | ||
| .prettierignore | ||
| 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 (cargo 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.
Table of Contents
The table of contents files (theme/page-toc.js and theme/page-doc.css) were initially generated by mdbook-pagetoc.
Since all these preprocessor does is generate the static assets, we don't need to keep it around once they have been generated.