Skip to content

Commit

Permalink
feat: Add GitHub Pages workflow (#50)
Browse files Browse the repository at this point in the history
* feat: Add GitHub Pages workflow
* chore: Switch to GitHub pages
  • Loading branch information
erictuvesson authored Jan 11, 2024
1 parent 5e89922 commit 8fcb660
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 24 deletions.
56 changes: 56 additions & 0 deletions .github/workflows/pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Use Node.js 18.x
uses: actions/setup-node@v4
with:
node-version: 18.x
cache: "npm"
- run: npm install
continue-on-error: true
- run: npm run build
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: build

deploy:
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
# TODO: Do we need checkout here?
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
26 changes: 2 additions & 24 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,39 +1,17 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

//const lightCodeTheme = require('prism-react-renderer/themes/github');
//const darkCodeTheme = require('prism-react-renderer/themes/dracula');

const {
_parseNoodlMarkupPlugin,
_parseRenderedMarkupPlugin,
} = require('./plugins/markdown-syntax');

const version = require('./package.json')
.version.split('.')
.slice(0, 2)
.join('.');

// Reverse the sidebar items ordering (including nested category items)
function reverseSidebarItems(items) {
// Reverse items in categories
const result = items.map((item) => {
if (item.type === 'category') {
return { ...item, items: reverseSidebarItems(item.items) };
}
return item;
});
// Reverse items at current level
result.reverse();
return result;
}

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Noodl',
tagline: 'Dinosaurs are cool',
url: 'https://docs.noodl.net',
baseUrl: `/${version}/`,
url: 'https://noodlapp.github.io',
baseUrl: `/noodl-docs/`,
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
Expand Down

0 comments on commit 8fcb660

Please sign in to comment.