Migrate the markdown documentation to MDBook

.github/workflows/mdbook.yml

@@ -0,0 +1,75 @@
+# Sample workflow for building and deploying a mdBook site to GitHub Pages
+#
+# To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html
+#
+name: Deploy mdBook site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      MDBOOK_VERSION: 0.4.36
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Cache cargo registry and mdBook binary
+        id: cache-mdbook
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/mdbook
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+          key: ${{ runner.os }}-cargo-mdbook-${{ env.MDBOOK_VERSION }}
+
+      - name: Install mdBook
+        if: steps.cache-mdbook.outputs.cache-hit != 'true'
+        run: |
+          curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
+          rustup update
+          cargo install --version ${MDBOOK_VERSION} mdbook
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Build with mdBook
+        run: mdbook build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./book
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

.gitignore

@@ -1,2 +1 @@
-notes.txt
-index.html
+book

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "theme"]
+	path = theme
+	url = git@github.com:beastr45/ASIC-network_MDBookTheme.git

README.md

@@ -1,4 +1,31 @@
+# analog-tutorials
+
+Open documentation for analog IC design, built with [mdBook](https://rust-lang.github.io/mdBook/).
+
 **This is still a work in progress.**
 
+## Clone
+
+`theme/` is a git submodule (shared with the rest of the network's docs
+books — see [asic-network-docs/theme](../theme)):
+
+```
+git clone --recurse-submodules <this-repo-url>
+# or, after a plain clone:
+git submodule update --init
+```
+
+## Preview locally
+
+```
+mdbook serve
+```
+
+## Writing pages
+
+One `src/*.md` file per page, listed in order in `src/SUMMARY.md`. Copy
+`src/TEMPLATE.md` to start a new one — see the comment at the top of that
+file for the authoring rules (linking, images, etc).
+
 # To-do
 * add an authors list section at the end of the pages so its easy for newer people to reach out to the right person if they are willing to contribute