Skip to content

Commit

Permalink
Documentation: Rebuild documentation site with Greendoc + SvelteKit (#…
Browse files Browse the repository at this point in the history
…940)

- Rebuild docs site with Greendoc + SvelteKit
- Remove TypeDoc dependency
- Removes H1 headers from class JSDoc 
- Adds missing category tags
- Remove CI tests on Node.js v14 (EOL+blocked)
- Overhaul site navigation
- Improve standalone docs pages
- Add navigation for /functions package
  • Loading branch information
donmccurdy authored May 16, 2023
1 parent 4e77310 commit 9272713
Show file tree
Hide file tree
Showing 184 changed files with 5,799 additions and 6,771 deletions.
83 changes: 46 additions & 37 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,39 +1,48 @@
{
"parser": "@typescript-eslint/parser",
"plugins": [
"@typescript-eslint"
],
"env": {
"browser": true,
"es6": true,
"node": true
},
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended",
"prettier"
],
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly"
},
"parserOptions": {
"ecmaVersion": 2018,
"sourceType": "module"
},
"rules": {
"@typescript-eslint/no-use-before-define": "off",
"@typescript-eslint/no-unused-vars": ["warn", {"argsIgnorePattern": "^_"}],
"@typescript-eslint/no-var-requires": ["off"],
"@typescript-eslint/no-non-null-assertion": ["off"],
"max-len": ["warn", {"code": 120, "tabWidth": 4, "ignoreUrls": true, "ignorePattern": "^import|^export"}],
"semi": ["error"],
"eqeqeq": ["warn", "smart"],
"space-infix-ops": ["warn"],
"array-bracket-spacing": ["warn"],
"no-irregular-whitespace": ["warn"],
"comma-spacing": ["warn"]
},
"ignorePatterns": ["**/*.js"]
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint"],
"ignorePatterns": ["**/*.js"],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended",
"plugin:svelte/recommended",
"prettier"
],
"parserOptions": {
"ecmaVersion": 2020,
"sourceType": "module",
"extraFileExtensions": [".svelte"]
},
"env": {
"browser": true,
"es2017": true,
"node": true
},
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly"
},
"overrides": [
{
"files": ["*.svelte"],
"parser": "svelte-eslint-parser",
"parserOptions": {
"parser": "@typescript-eslint/parser"
}
}
],
"rules": {
"@typescript-eslint/no-use-before-define": "off",
"@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }],
"@typescript-eslint/no-var-requires": ["off"],
"@typescript-eslint/no-non-null-assertion": ["off"],
"max-len": ["warn", { "code": 120, "tabWidth": 4, "ignoreUrls": true, "ignorePattern": "^import|^export" }],
"semi": ["error"],
"eqeqeq": ["warn", "smart"],
"space-infix-ops": ["warn"],
"array-bracket-spacing": ["warn"],
"no-irregular-whitespace": ["warn"],
"comma-spacing": ["warn"]
}
}
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x, 18.x]
node-version: [18.x]
env:
CI: true
steps:
Expand Down
13 changes: 10 additions & 3 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
# General
**/dist
**/build
**/in
**/out
**/*.md
**/*.hbs
**/*.json
**/*.yml
**/*.lock
**/*.css

# Documentation
packages/docs/.svelte-kit

# Lockfiles
pnpm-lock.yaml
package-lock.json
yarn.lock
5 changes: 4 additions & 1 deletion .prettierrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,8 @@
"useTabs": true,
"tabWidth": 4,
"printWidth": 120,
"bracketSpacing": true
"bracketSpacing": true,
"plugins": ["prettier-plugin-svelte"],
"pluginSearchDirs": ["."],
"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
}
7 changes: 6 additions & 1 deletion .vercelignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
packages
packages/core
packages/extensions
packages/functions
packages/cli
packages/test-utils
node_modules
test
.svelte-kit
5 changes: 0 additions & 5 deletions docs/_CREDITS.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/_UNRATIFIED_EXTENSIONS.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/_VENDOR_EXTENSIONS.md

This file was deleted.

102 changes: 0 additions & 102 deletions docs/pages.ts

This file was deleted.

Loading

0 comments on commit 9272713

Please sign in to comment.