Skip to content

Commit

Permalink
Migrate Docs from Jekyll to Astro (#11)
Browse files Browse the repository at this point in the history
* feat(docs): initialize Astro documentation setup with configuration files

* refactor(docs): update pages to be Astro

* feat(docs): add SEO plugin, use public folder, seperate css and scripts into seperate files

* chore: update GitHub Actions workflow to use Node.js and install dependencies for documentation build

---------

Co-authored-by: Cody Bromley <[email protected]>
  • Loading branch information
codybrom and codybrom authored Jan 8, 2025
1 parent c9165e1 commit 68bb428
Show file tree
Hide file tree
Showing 39 changed files with 9,018 additions and 1,197 deletions.
32 changes: 14 additions & 18 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,36 +31,32 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Pages
uses: actions/configure-pages@v5

- name: Setup Ruby
uses: ruby/setup-ruby@v1
- name: Setup Node
uses: actions/setup-node@v4
with:
ruby-version: "3.3.0"
bundler-cache: true
working-directory: ./docs
node-version: 22
cache: "npm"
cache-dependency-path: "./docs/package-lock.json"

- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./docs
destination: ./_site
verbose: true
env:
JEKYLL_ENV: production
VERBOSE: true
- name: Install dependencies
run: npm ci
working-directory: ./docs

- name: Build site
run: npm run build
working-directory: ./docs

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "./docs/dist"

deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
Expand Down
17 changes: 17 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# build output
dist/
# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# environment variables
.env
.env.production
26 changes: 0 additions & 26 deletions docs/_config.yml

This file was deleted.

Loading

0 comments on commit 68bb428

Please sign in to comment.