Generate docs with @2gis/js-docs-generator

Author: Dmitry Nishcheta

.github/workflows/prettier-check.yml

@@ -9,6 +9,6 @@ jobs:
             - uses: actions/checkout@v3
             - uses: actions/setup-node@v3
               with:
-                  node-version: 16
+                  node-version: 18
             - run: npm ci
             - run: npm run prettier

.github/workflows/release.yml

@@ -13,10 +13,12 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 16
+          node-version: 18
           registry-url: https://registry.npmjs.org/
+      - run: echo "TAG=$(git describe --tags --abbrev=0)" >> $GITHUB_ENV
       - run: npm ci
       - run: npm run build
       - run: npm publish --access public
         env:
+          VERSION: ${{ env.TAG }}
           NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
             - uses: actions/checkout@v3
             - uses: actions/setup-node@v3
               with:
-                  node-version: 16
+                  node-version: 18
             - run: npm ci
             - run: npm run test:screenshots
             - uses: actions/upload-artifact@v3

build/documentalist.js

@@ -1,15 +1,24 @@
-const { Documentalist, TypescriptPlugin } = require('@documentalist/compiler');
-const { mkdirSync, writeFileSync } = require('fs');
+const { generateDocs } = require('@2gis/js-docs-generator');
+const fs = require('fs');
+const path = require('path');
 
-mkdirSync('dist', {
-    recursive: true,
-});
+const version = process.env.VERSION || 'branch';
+fs.mkdirSync(path.join('dist', 'docs', version), { recursive: true });
 
-new Documentalist()
-    .use(/\.ts$/, new TypescriptPlugin())
-    .documentGlobs('src/*')
-    .then((docs) => JSON.stringify(docs))
-    .then((json) => writeFileSync('dist/docs.json', json))
+generateDocs({
+    version,
+    defaultReference: 'Deck2gisLayer',
+    docsHost: 'https://unpkg.com/@2gis/deck2gis-layer@^2/dist/docs',
+    excludePaths: [],
+    globs: ['src/**/*'],
+    ignoreMarkdown: true,
+    legacyOutPath: 'dist/docs.json',
+})
+    .then((result) => {
+        fs.writeFileSync(path.join('dist', 'docs', 'manifest.json'), result.manifest);
+        fs.writeFileSync(path.join('dist', 'docs', version, 'en.json'), result.reference.en);
+        fs.writeFileSync(path.join('dist', 'docs', version, 'ru.json'), result.reference.ru);
+    })
     .catch((e) => {
         console.log(e);
         process.exit(1);