Skip to content

Commit cdc6804

Browse files
Add MkDocs Material site with GitHub Pages deployment
Adds mkdocs.yml config and GitHub Actions workflow that auto-builds and deploys docs to GitHub Pages on push to main. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent caf6cbd commit cdc6804

2 files changed

Lines changed: 101 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'docs/**'
8+
- 'mkdocs.yml'
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: pages
17+
cancel-in-progress: true
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v4
24+
25+
- uses: actions/setup-python@v5
26+
with:
27+
python-version: '3.12'
28+
29+
- run: pip install mkdocs-material
30+
31+
- run: mkdocs build --strict
32+
33+
- uses: actions/upload-pages-artifact@v3
34+
with:
35+
path: site
36+
37+
deploy:
38+
needs: build
39+
runs-on: ubuntu-latest
40+
environment:
41+
name: github-pages
42+
url: ${{ steps.deployment.outputs.page_url }}
43+
steps:
44+
- id: deployment
45+
uses: actions/deploy-pages@v4

mkdocs.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
site_name: gmaps-extractor
2+
site_description: Extract business data from Google Maps at scale
3+
site_url: https://promisingcoder.github.io/GoogleMapsCollector/
4+
repo_url: https://github.com/promisingcoder/GoogleMapsCollector
5+
repo_name: promisingcoder/GoogleMapsCollector
6+
7+
theme:
8+
name: material
9+
palette:
10+
- scheme: default
11+
primary: blue grey
12+
accent: teal
13+
toggle:
14+
icon: material/brightness-7
15+
name: Switch to dark mode
16+
- scheme: slate
17+
primary: blue grey
18+
accent: teal
19+
toggle:
20+
icon: material/brightness-4
21+
name: Switch to light mode
22+
features:
23+
- navigation.instant
24+
- navigation.sections
25+
- navigation.top
26+
- search.highlight
27+
- content.code.copy
28+
29+
markdown_extensions:
30+
- tables
31+
- admonition
32+
- pymdownx.highlight:
33+
anchor_linenums: true
34+
- pymdownx.superfences
35+
- pymdownx.details
36+
37+
nav:
38+
- Home: index.md
39+
- Getting Started:
40+
- Installation: installation.md
41+
- Prerequisites & Setup: prerequisites.md
42+
- Quick Start: quick-start.md
43+
- Usage:
44+
- Python Library API: python-api.md
45+
- CLI Reference: cli-reference.md
46+
- Configuration: configuration.md
47+
- Features:
48+
- Output Format: output-format.md
49+
- Subdivision Mode: subdivision-mode.md
50+
- Resuming Collections: resuming-collections.md
51+
- Rate Limiting & Performance: rate-limiting.md
52+
- Reference:
53+
- Error Handling: error-handling.md
54+
- Troubleshooting: troubleshooting.md
55+
- Examples: examples.md
56+
- Known Limitations: known-limitations.md

0 commit comments

Comments
 (0)