build: serve crate docs (#353)

* build: crate docs

* docs: update table of contents
This commit is contained in:
Myriad-Dreamin 2024-06-28 10:03:26 +08:00 committed by GitHub
parent 7f1de87765
commit 54b0207fe1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 37 additions and 10 deletions

View file

@ -4,29 +4,34 @@
#show: book
#book-meta(
title: "Tinymist Documentation",
description: "The documentation for tinymist servaice",
title: "Tinymist Docs",
description: "The documentation for tinymist service",
authors: ("Myriad-Dreamin",),
repository-edit: "https://github.com/Myriad-Dreamin/tinymist/edit/main/{path}",
language: "en",
summary: [
#prefix-chapter("overview.typ")[Overview]
#prefix-chapter("introduction.typ")[Introduction]
= LSP
#prefix-chapter("overview.typ")[Overview of Service]
- #chapter("principles.typ")[Principles]
- #chapter("commands.typ")[Commands System]
- #chapter("inputs.typ")[LSP Inputs]
- #chapter("type-system.typ")[Type System]
- #chapter("language-features.typ")[Language Features]
= Editor Integration
#prefix-chapter("configurations.typ")[Common Configurations]
#prefix-chapter("frontend/main.typ")[Editor Frontends]
- #chapter("frontend/vscode.typ")[VS Cod(e,ium)]
- #chapter("frontend/neovim.typ")[NeoVim]
- #chapter("frontend/helix.typ")[Helix]
- #chapter("frontend/zed.typ")[Zed]
- #chapter("frontend/main.typ")[Editor Frontends]
- #chapter("frontend/vscode.typ")[VS Cod(e,ium)]
- #chapter("frontend/neovim.typ")[NeoVim]
- #chapter("frontend/helix.typ")[Helix]
- #chapter("frontend/zed.typ")[Zed]
],
)
#build-meta(dest-dir: "../../dist/tinymist")
#get-book-meta()
// re-export page template
#import "/typ/templates/page.typ": project
#let book-page = project

View file

@ -0,0 +1,17 @@
// dist/tinymist/rs
#import "mod.typ": *
#show: book-page.with(title: "Introduction")
Tinymist [ˈtaɪni mɪst] is an integrated language service for #link("https://typst.app/")[Typst] [taɪpst]. You can also call it "微霭" [wēi ǎi] in Chinese.
It contains:
- an analyzing library for Typst, see #link("https://github.com/Myriad-Dreamin/tinymist/tree/main/crates/tinymist-query")[tinymist-query].
- a CLI for Typst, see #link("https://github.com/Myriad-Dreamin/tinymist/tree/main/crates/tinymist/")[tinymist].
- which provides a language server for Typst.
- a VSCode extension for Typst, see #link("https://github.com/Myriad-Dreamin/tinymist/tree/main/editors/vscode/")[Tinymist VSCode Extension].
Further Reading:
- #cross-link("/overview.typ")[Overview of Service]
- #cross-link("/rs/tinymist/index.typ")[Tinymist Crate Docs (for Developers)]

View file

@ -1,6 +1,6 @@
#import "mod.typ": *
#show: book-page.with(title: "Tinymist")
#show: book-page.with(title: "Overview of Service")
This document gives an overview of tinymist service, which provides a single integrated language service for Typst. This document doesn't dive in details unless necessary.