feat: setup docs site (#3269)

Co-authored-by: Ivan Goncharov <[email protected]>

Author: saihaj

.eslintignore

@@ -1,9 +1,11 @@
 # Copied from '.gitignore', please keep it in sync.
 /.eslintcache
+/.docusaurus
 /node_modules
 /coverage
 /npmDist
 /denoDist
+/websiteDist
 
 # Ignore TS files inside integration test
 /integrationTests/ts/*.ts

.eslintrc.yml

@@ -12,7 +12,7 @@ plugins:
   - simple-import-sort
 settings:
   node:
-    tryExtensions: ['.js', '.json', '.node', '.ts', '.d.ts']
+    tryExtensions: ['.js', '.jsx', '.json', '.node', '.ts', '.d.ts']
 
 rules:
   ##############################################################################
@@ -691,3 +691,30 @@ overrides:
       import/no-nodejs-modules: off
       import/no-commonjs: off
       no-console: off
+  - files: '**/*.jsx'
+    parserOptions:
+      sourceType: module
+      ecmaFeatures:
+        jsx: true
+    rules:
+      node/no-unpublished-import: off
+      import/no-default-export: off
+  - files: 'website/**'
+    plugins:
+      - 'react'
+    extends:
+      - 'plugin:react/recommended'
+      - 'plugin:react-hooks/recommended'
+    settings:
+      react:
+        version: detect
+    rules:
+      node/no-unpublished-require: off
+      node/no-missing-import: off
+      import/no-default-export: off
+      import/no-commonjs: off
+      import/no-nodejs-modules: off
+      import/no-extraneous-dependencies: off
+      # Ignore docusarus related webpack aliases
+      import/no-unresolved:
+        ['error', { 'ignore': ['^@theme', '^@docusaurus', '^@generated'] }]

.github/workflows/ci.yml

@@ -70,8 +70,9 @@ jobs:
       - name: Install Dependencies
         run: npm ci --ignore-scripts
 
-      - name: Check that package-lock.json doesn't have conflicts
-        run: npm ls --depth 999
+      # Disabled due to https://github.com/milesj/docusaurus-plugin-typedoc-api/pull/19
+      # - name: Check that package-lock.json doesn't have conflicts
+      #  run: npm ls --depth 999
 
       - name: Run npm install
         run: npm install --force --package-lock-only --ignore-scripts --engine-strict --strict-peer-deps
@@ -298,3 +299,24 @@ jobs:
         with:
           src_dir: denoDist
           target_branch: deno
+
+  build-website:
+    name: Build website
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          cache: npm
+          node-version: ${{ env.NODE_VERSION_USED_FOR_DEVELOPMENT }}
+
+      - name: Install Dependencies
+        run: npm ci --ignore-scripts
+
+      - name: Build Docs
+        run: npm run build:website

.gitignore

@@ -8,7 +8,9 @@
 /diff-npm-package.html
 /.eslintcache
 /.cspellcache
+/.docusaurus
 /node_modules
 /coverage
 /npmDist
 /denoDist
+/websiteDist

.prettierignore

@@ -1,7 +1,9 @@
 # Copied from '.gitignore', please keep it in sync.
 /diff-npm-package.html
 /.eslintcache
+/.docusaurus
 /node_modules
 /coverage
 /npmDist
 /denoDist
+/websiteDist

cspell.yml

@@ -10,8 +10,17 @@ ignorePaths:
   - benchmark/github-schema.graphql
   - benchmark/github-schema.json
 overrides:
-  - filename: '**/docs/APIReference-*.md'
+  - filename: '**/docs-old/APIReference-*.md'
     ignoreRegExpList: ['/href="[^"]*"/']
+  - filename: 'website/**'
+    dictionaries:
+      - fullstack
+    words:
+      - clsx
+      - infima
+      - noopener
+      - noreferrer
+      - xlink
 
 ignoreRegExpList:
   - u\{[0-9a-f]{1,8}\}