📝 Transfer content into website

.github/workflows/docs.yml

@@ -31,9 +31,8 @@ jobs:
 
       - name: Build
         run: |
-          cd docs/src
-          typst compile reference.typ
-          cd ..
+          typst compile docs/src/reference.typ --root ./
+          cd docs
           mdbook build
 
       - name: Deploy to GitHub Pages

docs/src/SUMMARY.md

@@ -3,3 +3,4 @@
 - [Introduction](./introduction.md)
 - [Getting Started](./getting_started.md)
 - [API Reference](./reference.md)
+- [Developer Documentation](./developer_documentation.md)

docs/src/getting_started.md

@@ -0,0 +1,51 @@
+# Installation
+
+#info[
+This installation process is temporary, as we wait for Typst to overhaul its
+process for packaging templates and packages.
+]
+
+The best way to install the Notebookinator is as a local package. Make sure you
+have the following software installed on your computer:
+
+- [Typst](https://github.com/casey/just#installation)
+- [Git](https://github.com/casey/just#installation)
+- [VSCode](https://code.visualstudio.com/)
+- [just](https://github.com/casey/just#installation)
+
+Once you've installed everything, simply run the following commands:
+
+```bash
+git clone https://github.com/BattleCh1cken/notebookinator
+cd notebookinator
+just install
+```
+
+> If you're running this on Windows, you'll need to run these commands in a sh
+> shell, like git-bash or the shell packaged with Cygwin or GitHub Desktop.
+
+# Basic Usage
+
+Once the template is installed, you can import it into your project like this:
+
+```typ
+#import "@local/notebookinator:1.0.1": *
+```
+
+Once you've done that you can begin to write your notebook:
+
+```typ
+#import themes.default: default-theme, components
+
+#show: notebook.with(theme: default-theme)
+
+#create-body-entry(title: "My Entry")[
+ #lorem(200)
+]
+```
+
+You can then compile your notebook with the Typst CLI:
+
+```bash
+typst compile your-notebook-file.typ
+```

docs/src/introduction.md

@@ -0,0 +1,9 @@
+# Introduction
+
+Welcome to the Notebookinator, a Typst package meant to simplify the notebooking
+process for the Vex Robotics Competition. Its theming capabilities handle all of
+the styling for you, letting you jump right into writing documentation.
+
+While it was designed with VRC in mind, it could just as easily be used for
+other competitor systems such as the First Robotics Competition and the First
+Tech Challenge.

docs/src/reference.md

@@ -1,2 +1,3 @@
 # API Reference
 
+Check out the API reference [here](./reference.pdf).