diff --git a/.github/workflows/Book.yml b/.github/workflows/Book.yml new file mode 100644 index 0000000..482288e --- /dev/null +++ b/.github/workflows/Book.yml @@ -0,0 +1,49 @@ +# 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: + pull_request: + branches: main + push: + branches: main + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: +env: + CARGO_TERM_COLOR: always +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: write +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: checkout + uses: actions/checkout@v4 + - uses: actions-rs/toolchain@v1 + with: + default: true + toolchain: stable + - name: mdbook + run: cargo install mdbook mdbook-katex + - 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 + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + publish_branch: gh-pages + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./book/build + force_orphan: true diff --git a/.gitignore b/.gitignore index 2ea19a4..a8fe3aa 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ /arcwelderlib-sys/vendor/ArcWelderLib +/book/build /target Cargo.lock *.gcode diff --git a/README.md b/README.md new file mode 100644 index 0000000..a7b1d2e --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +[![book](https://img.shields.io/badge/slicey-Book-blue?logo=mdbook&logoColor=000000)](https://cmhamel.github.io/slicey) +[![Build Status](https://github.com/cmhamel/slicey/workflows/CI/badge.svg)](https://github.com/cmhamel/slicey/actions?query=workflow%3ACI) + +# Slicey +A grassroots effort to build a 3D printing slicer in rust. diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..52650e8 --- /dev/null +++ b/book.toml @@ -0,0 +1,29 @@ +[book] +authors = ["Craig M. Hamel", "Lucas K. Gallup"] +language = "en" +multilingual = false +src = "book/" +title = "slicey" + +[build] +build-dir = "book/build/" +create-missing = false + +[rust] +edition = "2021" + +[output.html] +edit-url-template = "https://github.com/cmhamel/slicey/edit/main/{path}" +git-repository-url = "https://github.com/cmhamel/slicey" + +# [preprocessor.cmdrun] + +[preprocessor.katex] +after = ["links"] + +# [preprocessor.repl] +# # iframe url, default is https://mr-addict.github.io/mdbook-repl/embed/ +# src = "https://mr-addict.github.io/mdbook-repl/embed/" + +# # python is disabled by default and loading is lazy +# python.enable = true \ No newline at end of file diff --git a/book/SUMMARY.md b/book/SUMMARY.md new file mode 100644 index 0000000..c5384bc --- /dev/null +++ b/book/SUMMARY.md @@ -0,0 +1,6 @@ +# slicey +Welcome to the slicey book + +TODO break down documentation into DLP vs. FFF/SLA + +- [Introduction](./introduction.md) diff --git a/book/introduction.md b/book/introduction.md new file mode 100644 index 0000000..db7a827 --- /dev/null +++ b/book/introduction.md @@ -0,0 +1,2 @@ +# Introduction +Some stuff here \ No newline at end of file