diff --git a/.github/workflows/mdbook.yml b/.github/workflows/mdbook.yml new file mode 100644 index 0000000..7826e71 --- /dev/null +++ b/.github/workflows/mdbook.yml @@ -0,0 +1,54 @@ +name: Publish mdbook +on: + push: + branches: ["main"] + + # Allows 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: + runs-on: ubuntu-latest + env: + MDBOOK_VERSION: 0.4.40 + MDBOOKKATEX_VERSION: 0.7.0 + steps: + - uses: actions/checkout@v4 + - name: Install mdBook + run: | + curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh + rustup update + cargo install --version ${MDBOOK_VERSION} mdbook + cargo install --version ${MDBOOKKATEX_VERSION} mdbook-katex + - name: Setup Pages + id: pages + uses: actions/configure-pages@v4 + - name: Build with mdBook + run: mdbook build + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./book + + 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@v4 diff --git a/README.md b/README.md index b07f60b..f9ff17a 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,9 @@ > Hackmds for sharing ideas, once there is consensus around it, move it into this repo to consolidate it. Also we can use PRs to discuss asynchronously specific ideas of the spec. ## Usage +A rendered version of the site can be found at: https://0xparc.github.io/pod2-docs/ + +To run it locally: - Needs [mdbook](https://github.com/rust-lang/mdBook), to install: `cargo install mdbook` +- Needs [mdbook-katex](https://github.com/lzanini/mdbook-katex), to install: `cargo install mdbook-katex` - Run locally: `mdbook serve`