mirror of
https://github.com/zed-industries/zed.git
synced 2024-10-23 23:09:42 +00:00
af24967195
To ease navigating on pages that are long and having a birds-eye view of all the available content. This is done client-side and done via the files initially generated by the `mdbook-pagetoc` plugin ([crates.io link here](https://crates.io/crates/mdbook-pagetoc)). <img width="600" alt="Screenshot 2024-07-25 at 13 34 08" src="https://github.com/user-attachments/assets/a78c69e5-8cc4-4414-9d9c-27a4ceb27620"> --- Release Notes: - N/A --------- Co-authored-by: Marshall Bowers <elliott.codes@gmail.com>
29 lines
1.1 KiB
Markdown
29 lines
1.1 KiB
Markdown
# Zed Docs
|
|
|
|
Welcome to Zed's documentation.
|
|
|
|
This is built on push to `main` and published automatically to [https://zed.dev/docs](https://zed.dev/docs).
|
|
|
|
To preview the docs locally you will need to install [mdBook](https://rust-lang.github.io/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-proxy` that 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`.
|
|
|
|
### Table of Contents
|
|
|
|
The table of contents files (`theme/page-toc.js` and `theme/page-doc.css`) were initially generated by [`mdbook-pagetoc`](https://crates.io/crates/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.
|