Add docusaurus (#1)

* Add docusaurus

* Run format

Co-authored-by: PureSkill.gg <[email protected]>

Author: razor-x

.c8rc.json

@@ -13,6 +13,9 @@
     "esbenp.prettier-vscode"
   ],
   "postCreateCommand": "npm install",
-  "forwardPorts": [4001],
+  "forwardPorts": [3000],
+  "portsAttributes": {
+    "3000": { "label": "App" }
+  },
   "remoteUser": "node"
 }

.devcontainer/devcontainer.json

@@ -6,37 +6,23 @@ on:
   - pull_request
 
 jobs:
-  test:
+  build:
     runs-on: ubuntu-20.04
     timeout-minutes: 30
-    strategy:
-      matrix:
-        node:
-          - '14'
-          - '16'
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Setup
         uses: ./.github/actions/setup
-        with:
-          node_version: ${{ matrix.node }}
-      - name: Test
-        run: npm test
+      - name: Build
+        run: npm run build
   lint:
     runs-on: ubuntu-20.04
     timeout-minutes: 30
-    strategy:
-      matrix:
-        node:
-          - '14'
-          - '16'
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Setup
         uses: ./.github/actions/setup
-        with:
-          node_version: ${{ matrix.node }}
       - name: Lint
         run: npm run lint

.github/workflows/main.yml

@@ -60,13 +60,13 @@ jobs:
         id: version
         run: |
           echo "::set-output name=current::$(jq -r '.version' package.json)"
-      - name: Documentation
-        run: npm run docs:build
+      - name: Build
+        run: npm run build
       - name: Publish ${{ steps.version.outputs.current }}
         uses: peaceiris/actions-gh-pages@v3
         with:
           personal_token: ${{ secrets.GH_TOKEN }}
-          publish_dir: .docs
+          publish_dir: build
           keep_files: false
           cname: docs.pureskill.gg
           user_name: ${{ secrets.GIT_USER_NAME }}

.github/workflows/publish.yml

@@ -6,6 +6,7 @@
 # https://github.com/github/gitignore
 
 # Build directories
+build
 package
 .docs
 

.gitignore

@@ -8,7 +8,7 @@ PureSkill.gg community documentation.
 
 ## Description
 
-TODO
+Source for https://docs.pureskill.gg.
 
 ## Installation
 
@@ -20,7 +20,7 @@ $ npm install @pureskillgg/docs
 
 [npm]: https://www.npmjs.com/
 
-## Development and Testing
+## Development
 
 ### Quickstart
 
@@ -29,12 +29,7 @@ $ git clone https://github.com/pureskillgg/docs.git
 $ cd docs
 $ nvm install
 $ npm install
-```
-
-Run the command below in a separate terminal window:
-
-```
-$ npm run test:watch
+$ npm start
 ```
 
 Primary development tasks are defined under `scripts` in `package.json`
@@ -58,7 +53,7 @@ $ git clone [email protected]:pureskillgg/docs.git
 
 ### Requirements
 
-You will need [Node.js] with [npm] and a [Node.js debugging] client.
+You will need [Node.js] with [npm].
 
 Be sure that all commands run under the correct Node version, e.g.,
 if using [nvm], install the correct version with
@@ -80,7 +75,6 @@ $ npm install
 ```
 
 [Node.js]: https://nodejs.org/
-[Node.js debugging]: https://nodejs.org/en/docs/guides/debugging-getting-started/
 [npm]: https://www.npmjs.com/
 [nvm]: https://github.com/creationix/nvm
 

README.md

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')]
+}

ava.config.js

@@ -0,0 +1,4 @@
+---
+slug: /
+---
+# Home

babel.config.cjs

@@ -0,0 +1,25 @@
+const config = {
+  title: 'PureSkill.gg Docs',
+  tagline: 'Beep Boop.',
+  url: 'https://docs.pureskill.gg',
+  baseUrl: '/',
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en']
+  },
+  presets: [
+    [
+      '@docusaurus/preset-classic',
+      {
+        docs: {
+          routeBasePath: '/'
+        },
+        blog: false
+      }
+    ]
+  ]
+}
+
+module.exports = config