Skip to content

Commit

Permalink
Docusaurus (Consensys#17)
Browse files Browse the repository at this point in the history
* refactor: docusaurus init

* feat: gtag and gtm

* fix: remove goq references

* feat: add gtag and gtm

* feat: update docusaurus 2.3.1

* ci: pr template
  • Loading branch information
Ezzahhh authored Feb 6, 2023
1 parent ee1376d commit 4aec5cb
Show file tree
Hide file tree
Showing 79 changed files with 24,991 additions and 1,302 deletions.
52 changes: 52 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"version": "0.2",
"gitignoreRoot": ".",
"useGitignore": true,
"dictionaries": [
"css",
"html",
"fonts",
"typescript",
"softwareTerms",
"companies",
"lorem-ipsum",
"project-words"
],
"dictionaryDefinitions": [
{
"name": "project-words",
"path": "./project-words.txt",
"noSuggest": true
}
],
"ignorePaths": [
"CHANGELOG.md",
"LICENSE",
"package.json",
"yarn.lock",
"project-words.txt",
"__snapshots__",
"*.min.*",
"jest/vendor",
"docusaurus.config.js",
"src/css/",
"babel.config.js",
"api/",
"sidebars.js",
"tsconfig.*.json",
".github/**",
"__pycache__/**/*",
"docs/tutorials/send-private-transaction.md",
"docs/reference/plugins/security.md",
"docs/tutorials/kubernetes/*",
"docs/reference/logging-and-errors.md",
"docs/reference/cli-syntax.md",
"docs/reference/api-methods.md",
"docs/develop/client-libraries.md",
"docs/deploy/upgrade/migration.md",
"docs/configure-and-manage/manage/multi-tenancy/migration.md",
"docs/configure-and-manage/manage/json-rpc-api-security.md",
"docs/configure-and-manage/configure/use-configuration-file.md"
],
"ignoreRegExpList": ["Email", "Urls", "#[\\w-]*"]
}
26 changes: 13 additions & 13 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[*]
charset=utf-8
end_of_line=lf
trim_trailing_whitespace=true
insert_final_newline=true
indent_style=space
indent_size=2
# http://editorconfig.org

[.editorconfig]
indent_style=space
indent_size=4
root = true

[{*.yml,*.yaml}]
indent_style=space
indent_size=2
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
max_line_length = 80
trim_trailing_whitespace = true

[*.md]
insert_final_newline = false
trim_trailing_whitespace = false
7 changes: 7 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
build/
.eslintrc.js
docs/test-api
./node_modules/*
*.md
*.mdx
LICENSE
88 changes: 88 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
module.exports = {
env: {
browser: true,
es2021: true,
},
extends: [
"plugin:react/recommended",
"airbnb-typescript",
"plugin:import/typescript",
// @NOTE: Make sure this is always the last element in the array.
"plugin:prettier/recommended",
],
parser: "@typescript-eslint/parser",
parserOptions: {
ecmaVersion: 2020,
sourceType: "module",
ecmaFeatures: {
jsx: true,
},
project: ["./tsconfig.json"],
},
plugins: [
"react",
"react-hooks",
"jsx-a11y",
"import",
"prettier",
"@typescript-eslint",
],
settings: {
react: {
pragma: "React", // Pragma to use, default to "React"
fragment: "Fragment", // Fragment to use (may be a property of <pragma>), default to "Fragment"
version: "detect", // React version. "detect" automatically picks the version you have installed.
// You can also use `16.0`, `16.3`, etc, if you want to override the detected value.
// default to latest and warns if missing
// It will default to "detect" in the future
},
"import/parsers": {
"@typescript-eslint/parser": [".ts", ".tsx"],
},
"import/resolver": {
typescript: {},
},
},
rules: {
"import/prefer-default-export": 0,
"react/prop-types": 0,
"import/no-unresolved": [
"error",
{ ignore: ["^@theme", "^@docusaurus", "^@site"] },
],
"no-nested-ternary": 0,
"no-console": 0,
"no-unused-vars": 0,
"no-use-before-define": 0,
"arrow-body-style": 0,
"jsx-a11y/anchor-is-valid": 0,
"jsx-a11y/no-static-element-interactions": 0,
"jsx-a11y/click-events-have-key-events": 0,
"@typescript-eslint/no-unused-expressions": 0,
"@typescript-eslint/no-unused-vars": ["warn", { args: "none" }],
"@typescript-eslint/no-use-before-define": "warn",
"react/require-default-props": 0,
"react/jsx-props-no-spreading": 0,
"react/button-has-type": 0,
"jsx-a11y/label-has-associated-control": [
"error",
{
labelComponents: [],
labelAttributes: [],
controlComponents: [],
assert: "either",
depth: 2,
},
],
"@typescript-eslint/naming-convention": [
"error",
{
selector: "variableLike",
leadingUnderscore: "forbid",
trailingUnderscore: "forbid",
format: ["camelCase", "PascalCase", "UPPER_CASE"],
},
],
"import/extensions": 0,
},
};
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Bug report
about: Create a bug report.
title: ''
labels: DocOps
assignees: NicolasMassart

title: ""
labels: Documentation
assignees: Ezzahhh
---

## Describe the bug
Expand Down
7 changes: 2 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Pull request checklist

Use the following template to make sure your PR fits the Doctools documentation standard.
Use the following template to make sure your PR fits the ConsenSys documentation standard.

## Before creating the PR

Expand Down Expand Up @@ -34,9 +34,6 @@ For content changes:
For tool changes:

- [ ] Build and QA tools
- [ ] MkDocs templates
- [ ] MkDocs configuration
- [ ] Python dependencies
- [ ] Node dependencies and JavaScript
- [ ] GitHub integration

Expand All @@ -45,4 +42,4 @@ For tool changes:
Make sure that:

- [ ] You've [fixed any issues](https://consensys.net/docs/doctools/en/latest/contribute/fix-cicd-errors/) raised by the tests.
- [ ] You've [previewed your changes on GitHub Pages](https://consensys.net/docs/doctools/en/latest/preview/new-system/#preview-on-github-pages)
- [ ] You've previewed your changes on Vercel below.
42 changes: 0 additions & 42 deletions .github/vale/.vale.ini

This file was deleted.

60 changes: 0 additions & 60 deletions .github/vale/styles/Consensys/Acronyms.yml

This file was deleted.

45 changes: 0 additions & 45 deletions .github/vale/styles/Consensys/Headings.yml

This file was deleted.

15 changes: 0 additions & 15 deletions .github/vale/styles/Consensys/Inclusive.yml

This file was deleted.

8 changes: 0 additions & 8 deletions .github/vale/styles/Consensys/Latin.yml

This file was deleted.

Loading

0 comments on commit 4aec5cb

Please sign in to comment.