Skip to content

Commit fe051a0

Browse files
committed
docs: migrate to Docsify documentation with automated publishing
- Replace VitePress with Docsify for documentation site - Add GitHub Actions workflow for automated Docsify publishing - Create comprehensive ApexDocs generation script - Set up new documentation structure with sidebar navigation - Add docsify-cli for local development and serving - Update .gitignore for build artifacts and npm cache BREAKING CHANGE: Documentation URL and structure changed from VitePress to Docsify
1 parent 7cac8da commit fe051a0

24 files changed

Lines changed: 4593 additions & 6100 deletions
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Publish Docsify site
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
jobs:
15+
build:
16+
name: Build site
17+
runs-on: ubuntu-latest
18+
outputs:
19+
site-dir: apexdocs
20+
steps:
21+
- uses: actions/checkout@v4
22+
- uses: actions/setup-node@v4
23+
with:
24+
node-version: 20
25+
cache: npm
26+
- name: Install npm dependencies
27+
run: npm ci
28+
- name: Build documentation
29+
run: bash ./generateapexdocs.sh
30+
- name: Upload Pages artifact
31+
uses: actions/upload-pages-artifact@v1
32+
with:
33+
path: apexdocs
34+
35+
deploy:
36+
name: Deploy Pages artifact
37+
needs: build
38+
runs-on: ubuntu-latest
39+
permissions:
40+
pages: write
41+
steps:
42+
- uses: actions/deploy-pages@v1

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,8 @@
22
.vscode/settings.json
33
.sf/
44
apex-documentation
5-
node_modules/
5+
.npm-cache/
6+
node_modules/
7+
8+
# static site build artifacts generated by Docsify
9+
apexdocs/dist/

apexdocs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Reference Guide
2+
3+
## Apex Test Data Factory
4+
5+
### [TestDataFactory](apex-test-data-factory/TestDataFactory.md)
6+
7+
Provides reusable utilities for generating test SObject records with default and override values.

apexdocs/_sidebar.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* [Reference Guide](README.md)
2+
* [Apex Test Data Factory](apex-test-data-factory/TestDataFactory.md)

0 commit comments

Comments
 (0)