Skip to content

Commit

Permalink
feat(docu): add docusaurus integration
Browse files Browse the repository at this point in the history
Signed-off-by: Dominik Pinsel <[email protected]>
  • Loading branch information
DominikPinsel committed May 8, 2024
1 parent 179b590 commit e298a64
Show file tree
Hide file tree
Showing 46 changed files with 16,142 additions and 243 deletions.
57 changes: 57 additions & 0 deletions .github/workflows/docusaurus.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main
paths:
- 'documentation/**'

permissions:
contents: read
deployments: write
pages: write

jobs:
build:
name: Build Docusaurus
runs-on: [ self-hosted, Linux, road-runner, small ]
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- uses: actions/setup-node@v4
with:
node-version: 18
cache: yarn
cache-dependency-path: documentation/yarn.lock

- name: Install dependencies
run: yarn --cwd documentation install --frozen-lockfile

- name: Build Documentation
run: yarn --cwd documentation build

- name: Upload Build Artifact
uses: actions/[email protected]
with:
path: documentation/build

deploy:
name: Deploy to GitHub Pages
runs-on: [ self-hosted, Linux, road-runner, small ]
needs: build

permissions:
pages: write
id-token: write

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v3
164 changes: 0 additions & 164 deletions docs/Development.md

This file was deleted.

20 changes: 20 additions & 0 deletions documentation/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
25 changes: 25 additions & 0 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ npm
```

### Local Development

```
$ npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
3 changes: 3 additions & 0 deletions documentation/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
Loading

0 comments on commit e298a64

Please sign in to comment.