diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 1d055d4..f0c39b0 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -3,6 +3,8 @@ name: Deploy Docs on: push: branches: [main] + pull_request: + branches: [main] workflow_dispatch: permissions: @@ -33,6 +35,7 @@ jobs: path: site deploy: + if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' needs: build runs-on: ubuntu-latest environment: diff --git a/README.md b/README.md new file mode 100644 index 0000000..fd41915 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# MbientLab Documentation + +Documentation for MbientLab MetaSensors and the MetaWear BLE serial protocol. + +**Live site**: [docs.mbientlab.com](https://docs.mbientlab.com) + +## Local development + +```bash +pip install -r requirements.txt +mkdocs serve +``` + +Open [http://127.0.0.1:8000](http://127.0.0.1:8000). + +## Deployment + +Pushes to `main` automatically build and deploy via GitHub Pages. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 97e6ef5..0fef383 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -13,9 +13,9 @@ --md-primary-fg-color--dark: #008a91; --md-accent-fg-color: #00ABB3; --md-accent-fg-color--transparent: rgba(0, 171, 179, 0.1); - --md-default-bg-color: #1a1a2e; - --md-default-bg-color--light: #222240; - --md-default-bg-color--lighter: #2a2a4a; + --md-default-bg-color: #000000; + --md-default-bg-color--light: #111111; + --md-default-bg-color--lighter: #1a1a1a; } /* ── Typography tweaks ── */