Skip to content

Commit fe3d86c

Browse files
committed
docs: add github pages deployment instructions to readme
1 parent 08c1f59 commit fe3d86c

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,17 @@ A high-performance, feature-rich template for MkDocs using the Material theme.
2323
```
2424
4. **Edit `mkdocs.yml`**: Update the `site_name`, `repo_url`, and other metadata.
2525

26+
## 🌐 Deployment
27+
28+
This template is set up to deploy automatically via GitHub Actions.
29+
30+
1. **Push to `main`**: Any push to the `main` branch triggers the deployment workflow.
31+
2. **Configure GitHub Pages**:
32+
- Go to your repository **Settings** > **Pages**.
33+
- Under **Build and deployment** > **Source**, select **"Deploy from a branch"**.
34+
- Select the **`gh-pages`** branch (created after the first successful action run) and the **`/(root)`** folder.
35+
- Click **Save**.
36+
2637
## 📁 Structure
2738

2839
- `docs/`: Markdown files and documentation source.

0 commit comments

Comments
 (0)