-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #118 from samvera/nextra-docs
Update documentation and create static site
- Loading branch information
Showing
53 changed files
with
8,758 additions
and
212 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,47 @@ | ||
| { | ||
| "extends" : [ | ||
| "standard" | ||
| ], | ||
| "env" : { | ||
| "browser" : false | ||
| "extends": ["standard"], | ||
| "env": { | ||
| "browser": false | ||
| }, | ||
| "globals" : { | ||
| "__DEV__" : false, | ||
| "__TEST__" : false, | ||
| "__PROD__" : false, | ||
| "__COVERAGE__" : false | ||
| "globals": { | ||
| "__DEV__": false, | ||
| "__TEST__": false, | ||
| "__PROD__": false, | ||
| "__COVERAGE__": false | ||
| }, | ||
| "ignorePatterns": "tests/*", | ||
| "rules" : { | ||
| "brace-style" : [2, "1tbs"], | ||
| "comma-dangle" : [2, "never"], | ||
| "indent" : ["error", 2, {"SwitchCase" : 1}], | ||
| "key-spacing" : 0, | ||
| "max-len" : [0, 120, 2], | ||
| "max-lines-per-function": ["warn", {"max": 30, "skipBlankLines": true, "skipComments": true}], | ||
| "no-unused-vars" : [1, { "vars": "all", "args": "after-used", "ignoreRestSiblings": false, "argsIgnorePattern": "^_" }], | ||
| "no-var" : 1, | ||
| "object-curly-spacing" : [2, "always"], | ||
| "prefer-const" : [1, { | ||
| "destructuring" : "any", | ||
| "ignoreReadBeforeAssign" : true | ||
| }], | ||
| "semi" : [2, "always"], | ||
| "space-in-parens" : ["error", "never"], | ||
| "rules": { | ||
| "brace-style": [2, "1tbs"], | ||
| "comma-dangle": [2, "never"], | ||
| "indent": ["error", 2, { "SwitchCase": 1 }], | ||
| "key-spacing": 0, | ||
| "max-len": [0, 120, 2], | ||
| "max-lines-per-function": [ | ||
| "warn", | ||
| { "max": 30, "skipBlankLines": true, "skipComments": true } | ||
| ], | ||
| "no-unused-vars": [ | ||
| 1, | ||
| { | ||
| "vars": "all", | ||
| "args": "after-used", | ||
| "ignoreRestSiblings": false, | ||
| "argsIgnorePattern": "^_" | ||
| } | ||
| ], | ||
| "no-var": 1, | ||
| "object-curly-spacing": [2, "always"], | ||
| "prefer-const": [ | ||
| 1, | ||
| { | ||
| "destructuring": "any", | ||
| "ignoreReadBeforeAssign": true | ||
| } | ||
| ], | ||
| "semi": [2, "always"], | ||
| "space-in-parens": ["error", "never"], | ||
|
|
||
| // This should replicate Code Climate's computational complexity code smells warning. It is actually more strict. | ||
| "complexity" : ["warn", 5] | ||
| "complexity": ["warn", 5] | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| name: Deploy docs to GitHub Pages | ||
| on: | ||
| push: | ||
| branches: ["main"] | ||
| workflow_dispatch: | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| defaults: | ||
| run: | ||
| working-directory: ./docs | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| - name: Setup Node | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 16 | ||
| cache: npm | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v3 | ||
| with: | ||
| static_site_generator: next | ||
| - name: Restore cache | ||
| uses: actions/cache@v3 | ||
| with: | ||
| path: | | ||
| docs/.next/cache | ||
| key: ${{ runner.os }}-nextjs-${{ hashFiles('docs/**/package-lock.json') }}-${{ hashFiles('docs/**.[jt]s', 'docs/**.[jt]sx') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-nextjs-${{ hashFiles('docs/**/package-lock.json') }}- | ||
| - name: Install dependencies | ||
| run: npm install | ||
| - name: Build with Next.js | ||
| run: npx --no-install next build | ||
| env: | ||
| NEXTJS_BASE_PATH: /serverless-iiif | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v2 | ||
| with: | ||
| path: ./docs/out | ||
|
|
||
| # Deployment job | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "editor.codeActionsOnSave": { | ||
| "source.fixAll.sortJSON": false | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
|
|
||
| "rules": { | ||
| "space-before-function-paren": 0, | ||
| "react/prop-types": 0 | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
|
||
| # dependencies | ||
| /node_modules | ||
| /.pnp | ||
| .pnp.js | ||
|
|
||
| # testing | ||
| /coverage | ||
|
|
||
| # next.js | ||
| /.next/ | ||
| /out/ | ||
|
|
||
| # production | ||
| /build | ||
|
|
||
| # misc | ||
| .DS_Store | ||
| *.pem | ||
|
|
||
| # debug | ||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
|
|
||
| # local env files | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| # vercel | ||
| .vercel | ||
|
|
||
| # typescript | ||
| *.tsbuildinfo | ||
|
|
||
| # terraform | ||
| *.tfvars | ||
| /terraform/.terraform | ||
| /terraform/*.plan | ||
|
|
||
| # ephemeral build artifacts | ||
| /lib/honeybadger/config.vars.js | ||
|
|
||
| # vscode | ||
| /.vscode/* |
Oops, something went wrong.