Skip to content

Commit c2006cc

Browse files
author
Faxbot Agent
committed
chore(docs): add mkdocs.yml and CI to publish to gh-pages via mike from auto-tunnel
1 parent 9d4f240 commit c2006cc

File tree

2 files changed

+114
-0
lines changed

2 files changed

+114
-0
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Publish MkDocs (mike)
2+
3+
on:
4+
push:
5+
branches: [ auto-tunnel ]
6+
paths:
7+
- 'mkdocs.yml'
8+
- 'mkdocs/**'
9+
10+
jobs:
11+
build-and-deploy:
12+
runs-on: ubuntu-latest
13+
permissions:
14+
contents: write
15+
steps:
16+
- uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0
19+
20+
- name: Setup Python
21+
uses: actions/setup-python@v5
22+
with:
23+
python-version: '3.11'
24+
25+
- name: Install mkdocs + material + mike
26+
run: |
27+
python -m pip install --upgrade pip
28+
pip install mkdocs mkdocs-material mike
29+
30+
- name: Build (sanity)
31+
run: |
32+
mkdocs build --strict
33+
34+
- name: Configure git author
35+
run: |
36+
git config user.name "github-actions[bot]"
37+
git config user.email "github-actions[bot]@users.noreply.github.com"
38+
39+
- name: Deploy latest to gh-pages
40+
env:
41+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42+
run: |
43+
mike deploy --push --remote origin --branch gh-pages latest -m "docs: publish latest from auto-tunnel"
44+
mike set-default --push --remote origin --branch gh-pages latest
45+

mkdocs.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
site_name: Faxbot Docs
2+
repo_url: https://github.com/DMontgomery40/Faxbot
3+
edit_uri: edit/auto-tunnel/mkdocs/docs/
4+
5+
docs_dir: mkdocs/docs
6+
7+
theme:
8+
name: material
9+
language: en
10+
features:
11+
- navigation.instant
12+
- navigation.tabs
13+
- navigation.top
14+
- search.suggest
15+
- search.highlight
16+
- content.code.copy
17+
palette:
18+
- scheme: slate
19+
primary: indigo
20+
accent: teal
21+
22+
plugins:
23+
- search
24+
- mike:
25+
version_selector: true
26+
canonical_version: latest
27+
28+
nav:
29+
- Getting started: getting-started/index.md
30+
- Setup:
31+
- Phaxio: setup/phaxio.md
32+
- Sinch (Fax v3): setup/sinch.md
33+
- SignalWire: setup/signalwire.md
34+
- Webhooks: setup/webhooks.md
35+
- Go‑Live:
36+
- Overview: go-live/index.md
37+
- Phaxio: go-live/phaxio.md
38+
- Sinch: go-live/sinch.md
39+
- SignalWire: go-live/signalwire.md
40+
- Documo (mFax): go-live/documo.md
41+
- HumbleFax: go-live/humblefax.md
42+
- SIP/Asterisk: go-live/sip-asterisk.md
43+
- FreeSWITCH: go-live/freeswitch.md
44+
- One‑Pagers:
45+
- Phaxio: go-live/phaxio-onepager.md
46+
- Sinch: go-live/sinch-onepager.md
47+
- SIP/Asterisk: go-live/sip-asterisk-onepager.md
48+
- HumbleFax: go-live/humblefax-onepager.md
49+
- Documo: go-live/documo-onepager.md
50+
- Admin Console:
51+
- Setup Wizard: admin-console/setup-wizard.md
52+
- Settings: admin-console/settings.md
53+
- Diagnostics: admin-console/diagnostics.md
54+
- API Keys: admin-console/api-keys.md
55+
- Plugin Builder: admin-console/plugin-builder.md
56+
- Networking:
57+
- Tunnels: networking/tunnels.md
58+
- Security:
59+
- Overview: security/index.md
60+
- OAuth / OIDC: security/oauth-setup.md
61+
- Network Hardening: security/network.md
62+
- Apps:
63+
- Overview: apps/index.md
64+
- iOS: apps/ios.md
65+
- Desktop (Electron): apps/electron.md
66+
- Reference: reference/index.md
67+
- Operations: operations/index.md
68+
- Troubleshooting: troubleshooting/index.md
69+

0 commit comments

Comments
 (0)