Merge pull request #220 from libp2p/theme/migrate-to-doks

refactor/migrate-to-doks

.editorconfig

@@ -1,11 +1,11 @@
+# editorconfig.org
+
+root = true
+
 [*]
-insert_final_newline = true
-indent_size = 2
 indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
 trim_trailing_whitespace = true
-
-[*.{md,yaml,yml,toml}]
-indent_size = 4
-
-[Makefile]
-indent_style = tab
+insert_final_newline = true

.eslintignore

@@ -0,0 +1,4 @@
+assets/js/index.js
+assets/js/katex.js
+assets/js/vendor
+node_modules

.eslintrc.json

@@ -0,0 +1,31 @@
+{
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es6": true,
+    "node": true
+  },
+  "extends": "eslint:recommended",
+  "globals": {
+    "Atomics": "readonly",
+    "SharedArrayBuffer": "readonly"
+  },
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "sourceType": "module"
+  },
+  "rules": {
+    "no-console": 0,
+    "quotes": ["error", "single"],
+    "comma-dangle": [
+      "error",
+      {
+        "arrays": "always-multiline",
+        "objects": "always-multiline",
+        "imports": "always-multiline",
+        "exports": "always-multiline",
+        "functions": "ignore"
+      }
+    ]
+  }
+}

.github/workflows/cicheck.yml

@@ -1,41 +1,34 @@
-name: CI
+name: Hyas CI
 
-# Controls when the action will run.
 on:
+  push:
+    branches: master
   pull_request:
-    branches: [ master ]
+    branches: master
 
 jobs:
-  cicheck:
-    runs-on: ubuntu-latest
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [16.x]
 
-    # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - name: Checkout
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0 # No shallow clone, we need all history!
-      - name: Setup Python
-        uses: actions/setup-python@v2.2.2
-      # Runs a set of commands using the runners shell
-      - name: Install dependencies
-        run: |
-          sudo apt-get update -y
-          sudo apt-get install -y optipng jpegoptim jq
-          pip install bs4
-          pip install requests
-          pip install scour
-      - name: Run CI Checks
-        env:
-          GH_USERNAME: ${{ secrets.GH_USERNAME }}
-          GH_USER_EMAIL: ${{ secrets.GH_USER_EMAIL }}
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
-          GH_USER_ID: ${{ secrets.GH_USER_ID }}
-          LANGUAGETOOLS_API_KEY: ${{ secrets.LANGUAGETOOLS_API_KEY }}
-          LANGUAGETOOLS_USERNAME: ${{ secrets.LANGUAGETOOLS_USERNAME }}
-          PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
-          FIRST_COMMIT: ${{ github.event.pull_request.base.sha }}
-          LAST_COMMIT: ${{ github.event.after }}
-          PR_NUMBER: ${{ github.event.pull_request.number }}
-        run: bash ${{github.workspace}}/scripts/cicheck.sh
+    - name: Check out Hyas project
+      uses: actions/checkout@v2
+
+    - name: Set up Node.js ${{ matrix.node }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node }}
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Run Hyas test script
+      run: npm test
+
+    - name: Build production website
+      run: npm run build

.gitignore

@@ -6,7 +6,13 @@ node_modules/
 public/
 tmp/
 
+/resources
+
 # Generated source files
 content/reference/pkg/*/
 src/styles/constants.less
 build
+
+# OS generated files
+.DS_Store
+.DS_Store?

.markdownlint-cli2.jsonc

@@ -0,0 +1,11 @@
+{
+  "config": {
+    "default": true,
+    "MD013": false,
+    "MD024": false,
+    "MD026": false,
+    "MD033": false,
+    "MD034": false
+  },
+  "ignores": ["node_modules", "CHANGELOG.md", "README.md"]
+}

.stylelintignore

@@ -0,0 +1,3 @@
+assets/scss/components/_syntax.scss
+assets/scss/vendor
+node_modules

.stylelintrc.json

@@ -0,0 +1,48 @@
+{
+  "extends": "stylelint-config-standard-scss",
+  "rules": {
+    "no-empty-source": null,
+    "string-quotes": "double",
+    "scss/comment-no-empty": null,
+    "max-line-length": null,
+    "scss/at-extend-no-missing-placeholder": null,
+    "scss/dollar-variable-colon-space-after": null,
+    "scss/dollar-variable-empty-line-before": null,
+    "color-function-notation": null,
+    "alpha-value-notation": null,
+    "selector-id-pattern": null,
+    "selector-class-pattern": null,
+    "scss/no-global-function-names": null,
+    "number-max-precision": null,
+    "hue-degree-notation": null,
+    "value-no-vendor-prefix": null,
+    "property-no-vendor-prefix": null,
+    "at-rule-no-unknown": [
+      true,
+      {
+        "ignoreAtRules": [
+          "extend",
+          "at-root",
+          "debug",
+          "warn",
+          "error",
+          "if",
+          "else",
+          "for",
+          "each",
+          "while",
+          "mixin",
+          "include",
+          "content",
+          "return",
+          "function",
+          "tailwind",
+          "apply",
+          "responsive",
+          "variants",
+          "screen"
+        ]
+      }
+    ]
+  }
+}

CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Contributor Code of Conduct
+
+The `docs` libp2p project follows the [`IPFS Community Code of Conduct`](https://github.com/ipfs/community/blob/master/code-of-conduct.md)

LICENSE

@@ -8,8 +8,6 @@ The above copyright notice and this permission notice shall be included in all c
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-
-
 =======================================================================
 
 Other written documentation and content licensed under the Creative Commons Attribution License as follows: