ebcc2945c5
PR #16501 introduced the new keybinding syntax for the docs and added Javascript- and CSS-files to the theme to implement the change. These new files were then referenced in the `book.toml` as well as added to the `index.hbs`. However, the manually added links to these assets in the [`index.hbs`-file](https://github.com/zed-industries/zed/pull/16501/files#diff-8fde917c42f58487036335ccc9980f1467790fc1c257ec57a0c44bc5dfc3ef4f) are neither needed nor resolvable: <img width="328" alt="grafik" src="https://github.com/user-attachments/assets/4a710b22-9274-4d27-96a8-6da59b0c9e68"> Therefore, this PR reverts the changes to the`index.hbs` - file, as the correct links to the needed assets are inserted via the `each`-directives from the `book.toml` respectively. Release Notes: - N/A |
||
|---|---|---|
| .. | ||
| 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.