Skip to content

Commit 3ef6468

Browse files
committed
website
1 parent 2ad8298 commit 3ef6468

21 files changed

+3696
-0
lines changed

.github/workflows/docs.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- '.github/workflows/docs.yml'
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: write
14+
15+
jobs:
16+
build-and-deploy:
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- name: Checkout main branch
21+
uses: actions/checkout@v4
22+
with:
23+
fetch-depth: 0
24+
25+
- name: Install pandoc
26+
run: |
27+
sudo apt-get update
28+
sudo apt-get install -y pandoc
29+
30+
- name: Build static site
31+
run: |
32+
chmod +x docs/build.sh
33+
cd docs && ./build.sh
34+
35+
- name: Deploy to website branch
36+
run: |
37+
# Configure git
38+
git config user.name "github-actions[bot]"
39+
git config user.email "github-actions[bot]@users.noreply.github.com"
40+
41+
# Save the built site
42+
cp -r docs/_site /tmp/_site
43+
44+
# Switch to website branch (create if doesn't exist)
45+
git checkout website 2>/dev/null || git checkout --orphan website
46+
47+
# Clear everything except .git
48+
git rm -rf . 2>/dev/null || true
49+
find . -maxdepth 1 ! -name '.git' ! -name '.' -exec rm -rf {} +
50+
51+
# Copy built site
52+
cp -r /tmp/_site/* .
53+
54+
# Create .nojekyll to bypass Jekyll processing
55+
touch .nojekyll
56+
57+
# Commit and push
58+
git add -A
59+
git commit -m "Deploy docs from ${GITHUB_SHA::8}" || echo "No changes to commit"
60+
git push origin website --force

docs/_nav.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Korppi Documentation Navigation
2+
# Format: SECTION: title
3+
# filename|Display Name
4+
#
5+
# To add a new page:
6+
# 1. Create docs/yourpage.md
7+
# 2. Add entry here under appropriate section
8+
# 3. Push to main branch
9+
10+
SECTION: Getting Started
11+
installation|Installation
12+
quick-start|Quick Start
13+
first-document|Your First Document
14+
15+
SECTION: Features
16+
formatting|Text Formatting
17+
comments|Comments & Reviews
18+
timeline|Timeline & History
19+
reconciliation|Reconciliation
20+
export|Export Options
21+
22+
SECTION: Reference
23+
keyboard-shortcuts|Keyboard Shortcuts
24+
file-format|File Format (.kmd)
25+
configuration|Configuration
26+
27+
SECTION: Help
28+
faq|FAQ
29+
troubleshooting|Troubleshooting
30+
contributing|Contributing

0 commit comments

Comments
 (0)