docs: setup mdbook (#27)

.github/workflows/docs.yaml

@@ -0,0 +1,40 @@
+name: docs
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # To push a branch
+      pages: write  # To push to a GitHub Pages site
+      id-token: write # To update the deployment status
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install latest mdbook
+        run: |
+          tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+          url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+          mkdir mdbook
+          curl -sSL $url | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+      - name: Build Book
+        run: |
+          # This assumes your book is in the root of your repository.
+          # Just add a `cd` here if you need to change to another directory.
+          cd docs
+          mdbook build
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: 'docs/book'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/.gitignore

@@ -0,0 +1 @@
+book

docs/SUMMARY.md

@@ -0,0 +1,28 @@
+# Summary
+
+[Introduction](introduction.md)
+
+# Tutorials
+
+- [Getting started on GitHub](tutorials/github.md)
+- [Getting started on GitLab]()
+
+# Explanation
+
+- [Release Pull Request](explanation/release-pr.md)
+
+# Guides
+
+- [Customizing Release Notes](guides/release-notes.md)
+- [Pre-releases](guides/pre-releases.md)
+- [Workflow Permissions on GitHub](guides/github-workflow-permissions.md)
+
+# Reference
+
+- [Pull Request Options](reference/pr-options.md)
+- [GitHub Action](reference/github-action.md)
+- [GitLab CI]()
+
+---
+
+[Changelog](changelog.md)

docs/book.toml

@@ -0,0 +1,8 @@
+[book]
+language = "en"
+multilingual = false
+src = "."
+title = "releaser-pleaser"
+
+[build]
+build-dir = "book"

docs/changelog.md

@@ -0,0 +1,3 @@
+# Changelog
+
+{{#include ../CHANGELOG.md:2: }}

docs/explanation/release-pr.md

@@ -0,0 +1 @@
+# Release Pull Request

docs/guides/github-workflow-permissions.md

@@ -0,0 +1 @@
+# Workflow Permissions on GitHub

docs/guides/pre-releases.md

@@ -0,0 +1 @@
+# Pre-releases

docs/guides/release-notes.md

@@ -0,0 +1 @@
+# Customizing Release Notes

docs/introduction.md

@@ -0,0 +1,3 @@
+# Introduction
+
+{{#include ../README.md:2:}}

docs/reference/github-action.md

@@ -0,0 +1 @@
+# GitHub Action

docs/reference/pr-options.md

@@ -0,0 +1 @@
+# Pull Request Options

docs/tutorials/github.md

@@ -0,0 +1 @@
+# GitHub