docs: add diplodoc documentation

.gitignore

@@ -7,5 +7,8 @@ node_modules
 
 # Artifacts
 dist
+dist-docs
+docs/diplodoc/pages/api
 storybook-static
 .cache
+.tmp

docs-gen.json

@@ -0,0 +1,8 @@
+{
+  "pathToTocFile": "./docs/diplodoc/toc.yaml",
+  "pathToDocsFolder": "./docs/diplodoc",
+  "typedocOptions": {
+    "out": "./docs/diplodoc/pages/api",
+    "entryFileName": "overview.md"
+  }
+}

docs/diplodoc/.yfm

@@ -0,0 +1,11 @@
+
+allowHTML: true
+staticContent: true
+addSystemMeta: true
+lang: en
+langs:
+  - en
+search:
+  provider: local
+  confidence: phrased
+  tolerance: 2

docs/diplodoc/index.yaml

@@ -0,0 +1,12 @@
+title: Gravity UI Charts
+base: ./
+meta:
+  title: Gravity UI Charts
+  noIndex: true
+links:
+  - title: Overview
+    href: ./pages/overview.md
+  - title: Get started
+    href: ./pages/get-started.md
+  - title: API
+    href: ./pages/api/overview.md

docs/diplodoc/pages/get-started.md

@@ -0,0 +1,7 @@
+## Get started
+
+{% note info %}
+
+Page is under construction
+
+{% endnote %}

docs/diplodoc/pages/overview.md

@@ -0,0 +1,7 @@
+## Overview
+
+{% note info %}
+
+Page is under construction
+
+{% endnote %}

docs/diplodoc/toc.yaml

@@ -0,0 +1,22 @@
+title: ''
+href: index.yaml
+navigation:
+  logo:
+    dark:
+      icon: https://storage.yandexcloud.net/gravity-ui-assets/gravity-logo-dark.svg
+      text: Charts
+    light:
+      icon: https://storage.yandexcloud.net/gravity-ui-assets/gravity-logo-light.svg
+      text: Charts
+  header:
+    rightItems:
+      - type: controls
+      - type: search
+items:
+  - name: Overview
+    href: ./pages/overview.md
+  - name: Get started
+    href: ./pages/get-started.md
+  - name: API
+    href: ./pages/api
+    autodoc: true

docs/src/Components/index.ts

@@ -0,0 +1 @@
+export * from '../../../src/components';

docs/src/Configuration/index.ts

@@ -0,0 +1,7 @@
+export type {ChartData} from '../../../src/types';
+export * from '../../../src/types/chart/axis';
+export * from '../../../src/types/chart/chart';
+export * from '../../../src/types/chart/legend';
+export * from '../../../src/types/chart/split';
+export * from '../../../src/types/chart/title';
+export * from '../../../src/types/chart/tooltip';

docs/src/Series/index.ts

@@ -0,0 +1,12 @@
+export * from '../../../src/types/chart/area';
+export * from '../../../src/types/chart/bar-x';
+export * from '../../../src/types/chart/bar-y';
+export * from '../../../src/types/chart/base';
+export * from '../../../src/types/chart/halo';
+export * from '../../../src/types/chart/line';
+export * from '../../../src/types/chart/marker';
+export * from '../../../src/types/chart/pie';
+export * from '../../../src/types/chart/scatter';
+export * from '../../../src/types/chart/series';
+export * from '../../../src/types/chart/treemap';
+export * from '../../../src/types/chart/waterfall';

docs/src/Utilities/index.ts

@@ -0,0 +1 @@
+export {MeaningfulAny} from '../../../src/types/misc';

gulpfile.docs.js

@@ -0,0 +1,32 @@
+/* eslint-disable no-console */
+const {exec} = require('node:child_process');
+const path = require('node:path');
+
+const browserSync = require('browser-sync').create();
+const {watch, series, parallel} = require('gulp');
+
+const DIST_PATH = './dist-docs';
+
+function build(cb) {
+    exec('npm run docs:build', (err, stdout, stderr) => {
+        console.log(stdout);
+        console.error(stderr);
+        cb(err);
+    });
+}
+
+function serve(cb) {
+    browserSync.init({server: path.resolve(DIST_PATH), port: 7007});
+    cb();
+}
+
+function reload(cb) {
+    browserSync.reload();
+    cb();
+}
+
+function watchFiles() {
+    watch(['./docs/diplodoc/**/*', './docs/src/**/*'], series(build, reload));
+}
+
+exports.default = series(build, parallel(serve, watchFiles));