Skip to content

Commit

Permalink
Setup GitHub Pages for documentation (#9)
Browse files Browse the repository at this point in the history
* Setup GitHub Pages for documentation
  • Loading branch information
rogebrd authored Oct 19, 2020
1 parent f546ce3 commit 3a02faf
Show file tree
Hide file tree
Showing 5 changed files with 3,731 additions and 5 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Update Documentation

on:
push:
branches:
- master

jobs:
documentation:
runs-on: ubuntu-latest
steps:
- name: Checkout Package 🛎️
uses: actions/checkout@v2
- name: Setup Node.JS 🎱
uses: actions/setup-node@v2.1.2
with:
node-version: 14
- name: Install Package 📥
run: |
npm install
- name: Build Package 🏗️
run: |
npm run build
- name: Build Documentation 📜
run: npm run generate-docs
- name: Push Documentation 🚚
uses: JamesIves/github-pages-deploy-action@releases/v3
with:
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: docs # The folder the action should deploy.
122 changes: 119 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,119 @@
package-lock.json
dist/
node_modules/
docs

# Base template from https://github.com/github/gitignore/blob/master/Node.gitignore
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
12 changes: 12 additions & 0 deletions .jsdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"source": {
"include": [
"./src"
]
},
"opts": {
"destination": "docs",
"readme": "./README.md",
"recurse": true
}
}
Loading

0 comments on commit 3a02faf

Please sign in to comment.