Skip to content

Commit 81fa80e

Browse files
committed
feat: Setup GitHub Pages documentation
- Add GitHub Actions workflow for automatic docs deployment - Create Jekyll configuration for GitHub Pages - Add front matter to index.md for Jekyll processing - Configure docs site with proper navigation and styling - Enable automatic deployment on push to main branch
1 parent 2bda60a commit 81fa80e

3 files changed

Lines changed: 64 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
- name: Setup Pages
24+
uses: actions/configure-pages@v4
25+
- name: Build with Jekyll
26+
uses: actions/jekyll-build-pages@v1
27+
with:
28+
source: ./docs
29+
destination: ./_site
30+
- name: Upload artifact
31+
uses: actions/upload-pages-artifact@v3
32+
33+
deploy:
34+
environment:
35+
name: github-pages
36+
url: ${{ steps.deployment.outputs.page_url }}
37+
runs-on: ubuntu-latest
38+
needs: build
39+
steps:
40+
- name: Deploy to GitHub Pages
41+
id: deployment
42+
uses: actions/deploy-pages@v4

docs/_config.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
title: Pathao Python SDK
2+
description: A comprehensive Python SDK for the Pathao Courier Merchant API
3+
baseurl: "/pathao-python"
4+
url: "https://yourusername.github.io"
5+
6+
markdown: kramdown
7+
highlighter: rouge
8+
theme: minima
9+
10+
plugins:
11+
- jekyll-feed
12+
- jekyll-sitemap
13+
14+
exclude:
15+
- .github/
16+
- .gitignore
17+
- README.md

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
layout: default
3+
title: Home
4+
---
5+
16
# Pathao Python SDK Documentation
27

38
Welcome to the comprehensive documentation for the Pathao Python SDK. This SDK provides a clean, Pythonic interface to integrate Pathao's courier services into your Python applications.

0 commit comments

Comments
 (0)