Add docs configuration and visualization #106 (#114)

* feat: generate markdown and page config docs

* fix: remove default word

* chore: move _config.yml to docs

* chore: update lock file

.eslintrc.js

@@ -6,14 +6,14 @@ module.exports = {
     // https://github.com/typescript-eslint/typescript-eslint/issues/251#issuecomment-567365174
     tsconfigRootDir: __dirname,
   },
-  plugins: ['@typescript-eslint', 'jsdoc'],
+  plugins: ['@typescript-eslint', 'eslint-plugin-tsdoc'],
   extends: [
     'airbnb-base',
     'airbnb-typescript/base',
     'plugin:@typescript-eslint/recommended',
     'prettier',
     'plugin:eslint-comments/recommended',
-    'plugin:jsdoc/recommended',
+    'plugin:@typescript-eslint/recommended',
   ],
   settings: {
     jsdoc: {
@@ -44,12 +44,8 @@ module.exports = {
     '@typescript-eslint/consistent-type-imports': 2,
     'eslint-comments/disable-enable-pair': ['error', { allowWholeFile: true }],
     'eslint-comments/no-unused-disable': 'error',
-    'jsdoc/require-returns': 'off',
-    'jsdoc/require-returns-type': 'off',
-    'jsdoc/require-param': 'off',
-    'jsdoc/require-param-type': 'off',
-    'jsdoc/no-types': 'off',
-    "import/prefer-default-export": "off",
+    'import/prefer-default-export': 'off',
+    'tsdoc/syntax': 'warn',
   },
   // Disable no-unused-expressions to allow chai 'expect' expressions in testing
   overrides: [

.gitignore

@@ -123,3 +123,7 @@ dist
 # OS metadata
 .DS_Store
 Thumbs.db
+
+## Jekyll & gh-pages
+.jekyll-cache
+_site/

README.md

@@ -1,6 +1,22 @@
-# fuels-ts
+![Fuels-ts SDK logo](./docs/assets/fuels-ts-logo.png)
 
-fuels-ts is a library for interacting with Fuel v2. With fuels-ts you can:
+**fuels-ts** is a library for interacting with **Fuel v2**. With fuels-ts you can:
+
+# Table of contents
+
+- [SDK documentation](./docs/packages)
+- [Features](#features)
+- [Usage](#usage)
+  - [Installation](#installation)
+  - [Calling Contracts](#calling-contracts)
+  - [Deploying Contracts](#deploying-contracts)
+  - [Generating Contract Types](#generating-contract-types)
+- [Contributing](#contributing)
+  - [Setup](#setup)
+  - [Testing](#testing)
+- [License](#license)
+
+## Features
 
 - [x] Deploy and call contracts
 - [x] Generate contract types with TypeChain

docs/_config.yml

@@ -0,0 +1,30 @@
+#Configuration
+remote_theme: pmarsceill/just-the-docs
+exclude: ["packages/README.md"]
+
+# Set a path/url to a logo that will be displayed instead of the title
+title: "Fuels-ts"
+logo: "./assets/fuels-ts-logo.png"
+
+# Features
+search_enabled: true
+
+search:
+  heading_level: 6
+  previews: 3
+  preview_words_before: 5
+  preview_words_after: 10
+  tokenizer_separator: /[\s/]+/
+  rel_url: false
+  button: false
+
+heading_anchors: true
+
+# Theme
+color_scheme: "fuel-dark"
+
+aux_links:
+  "GitHub":
+    - "//github.com/FuelLabs/fuels-ts"
+
+footer_content: ""

docs/_sass/color_schemes/fuel-dark.scss

@@ -0,0 +1,19 @@
+$green-000: #58c09b;
+
+$body-background-color: $grey-dk-300;
+$sidebar-color: $grey-dk-300;
+$border-color: $grey-dk-200;
+
+$body-text-color: $grey-lt-300;
+$body-heading-color: $grey-lt-000;
+$nav-child-link-color: $grey-dk-000;
+$search-result-preview-color: $grey-dk-000;
+
+$link-color: $green-000;
+$btn-primary-color: $green-000;
+$base-button-color: $grey-dk-250;
+
+$code-background-color: $grey-dk-250;
+$search-background-color: $grey-dk-250;
+$table-background-color: $grey-dk-250;
+$feedback-color: darken($sidebar-color, 3%);

docs/_sass/custom/custom.scss

@@ -0,0 +1,7 @@
+.search-input {
+  color: $grey-lt-300;
+}
+
+.nav-list .nav-list-item > .nav-list .nav-list-item .nav-list-link.active {
+  color: $grey-lt-300;
+}

docs/index.md

@@ -0,0 +1,11 @@
+---
+layout: default
+title: Home
+nav_order: 0
+---
+
+![Fuels-ts SDK logo](./assets/fuels-ts-logo.png)
+
+# Fuel TypeScript SDK
+
+`fuels-ts` is a library for interacting with [Fuel v2](https://fuel.network/)

docs/packages/README.md

@@ -0,0 +1,14 @@
+---
+layout: default
+title: "fuels-ts"
+has_children: true
+has_toc: false
+nav_order: 1
+---
+
+# fuels-ts
+
+## Modules
+
+- [@fuel-ts/providers](fuel-ts-providers/index.md)
+- [@fuel-ts/wallet](fuel-ts-wallet/index.md)