Skip to content

Commit

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

* feat: admonition 1

* fix: css banner text

* fix: favicon and logo

* feat: add some teku color in banner

* fix: admonition conversion

* feat: banner font clamp and gradient

* fix: light dark banner text

* fix: update gradient

* fix: tagline edit

* fix: linear gradient title

* fix: undo gradient title

* fix: better banner

* fix: subtitle pop in

* fix: no override

* fix: adjust wide clamp

* feat: add gtag and gtm

* fix: button text get started

* fix: bring in line to merge

* ci: skip case test

* fix: logo light dark

* fix: pr template
  • Loading branch information
Ezzahhh authored Feb 7, 2023
1 parent 72b9945 commit 88110f9
Show file tree
Hide file tree
Showing 100 changed files with 30,989 additions and 5,234 deletions.
164 changes: 0 additions & 164 deletions .circleci/config.yml

This file was deleted.

48 changes: 48 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"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/Configure-External-Signer-TLS.md",
"docs/Reference/**",
"docs/HowTo/Monitor/Logging.md",
"docs/HowTo/Get-Started/Installation-Options/Install-Binaries.md",
"docs/HowTo/Configure/Use-Configuration-File.md",
"docs/HowTo/External-Signer/Manage-keys.md",
"docs/HowTo/Troubleshoot/Troubleshooting.md"
],
"ignoreRegExpList": ["Email", "Urls", "#[\\w-]*"]
}
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# http://editorconfig.org

root = true

[*]
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,
},
};
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Bug report
about: Create a bug report.
title: ""
labels: Documentation
assignees: Ezzahhh
---

## Describe the bug

<!-- Add a clear and concise description of what the documentation bug is.
Include steps to reproduce the bug and what you expected to happen. -->

## System settings

<!-- Add the following information about your system: -->

- OS and version:
- Browser and version:
- Plugins activated in your browser:

## More context

<!-- Add any other context about the problem here, for example, screenshots or a small demo video. -->
6 changes: 1 addition & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,6 @@ For tool changes:

- [ ] CircleCI workflow
- [ ] Build and QA tools (for example lint or vale)
- [ ] MkDocs templates
- [ ] MkDocs configuration
- [ ] Python dependencies
- [ ] Node dependencies and JavaScript
- [ ] Read the Docs configuration
- [ ] GitHub integration
Expand All @@ -47,8 +44,7 @@ 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 Read the Docs](https://consensys.net/docs/doctools/en/latest/preview/old-system/#preview-on-read-the-docs)
and added a [preview link](#preview).
- [ ] You've previewed your changes with Vercel below.

## Preview

Expand Down
26 changes: 26 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Build

on:
pull_request:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
build:
name: Build
runs-on: ubuntu-latest
# the enviroment to deploy to / use secrets from
environment: no-secret
# modify the default permissions of the GITHUB_TOKEN, so as to only allow least priveleges
permissions:
contents: read
steps:
- uses: actions/checkout@v3

- name: Build
uses: ConsenSys/docs-gha/build@main
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Loading

1 comment on commit 88110f9

@vercel
Copy link

@vercel vercel bot commented on 88110f9 Feb 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

doc-teku – ./

doc-teku-git-main-infura-web.vercel.app
doc-teku-infura-web.vercel.app
doc-teku-eight.vercel.app

Please sign in to comment.