docs(book): Update book setup

tingerrr · Jul 24, 2024 · 481b299 · 481b299
1 parent 35b8b80
commit 481b299
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -32,7 +32,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: 'docs/book/book'
+          path: 'docs/book/build'
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
diff --git a/Justfile b/Justfile
@@ -26,7 +26,7 @@ ci $RUSTFLAGS='-Dwarnings' $RUSTDOCFLAGS='-Dwarnings':
 # clean all temporary directories and build artifacts
 clean:
 	rm -r target
-	rm -r {{ book-src / 'book' }}
+	rm -r {{ book-src / 'build' }}
 
 # install typst-test using cargo
 install:

diff --git a/docs/book/.gitignore b/docs/book/.gitignore
@@ -1 +1 @@
-book
+build
diff --git a/docs/book/book.toml b/docs/book/book.toml
@@ -1,6 +1,13 @@
 [book]
-authors = ["tingerrr"]
+title = "typst-test"
+description = "A guide and reference document for typst-test."
+authors = ["tingerrr <[email protected]>"]
 language = "en"
 multilingual = false
 src = "src"
-title = "typst-test"
+
+[build]
+build-dir = "build"
+
+[output.html]
+git-repository-url = "https://github.com/tingerrr/typst-test"