From 63f9ca29fcbea81af15c59037a13ae456234157e Mon Sep 17 00:00:00 2001 From: Artur Arseniev Date: Mon, 9 Jul 2018 01:03:59 +0200 Subject: [PATCH] More updates for API in docs --- docs/api.js | 28 ++++++++++++++-------------- docs/api/README.md | 3 +-- package.json | 2 +- 3 files changed, 16 insertions(+), 17 deletions(-) diff --git a/docs/api.js b/docs/api.js index c52fcb059..14bb8dfe3 100644 --- a/docs/api.js +++ b/docs/api.js @@ -6,20 +6,20 @@ const srcRoot = path.join(docRoot, '../src/'); const binRoot = path.join(docRoot, '../node_modules/.bin/'); const cmds = [ ['editor/index.js', 'editor.md'], - //['asset_manager/index.js', 'assets.md'], - //['block_manager/index.js', 'block_manager.md'], - //['commands/index.js', 'commands.md'], - //['dom_components/index.js', 'components.md'], - //['panels/index.js', 'panels.md'], - //['style_manager/index.js', 'style_manager.md'], - //['storage_manager/index.js', 'storage_manager.md'], - //['device_manager/index.js', 'device_manager.md'], - //['selector_manager/index.js', 'selector_manager.md'], - //['css_composer/index.js', 'css_composer.md'], - //['modal_dialog/index.js', 'modal_dialog.md'], - //['rich_text_editor/index.js', 'rich_text_editor.md'], - //['keymaps/index.js', 'keymaps.md'], - //['undo_manager/index.js', 'undo_manager.md'], + ['asset_manager/index.js', 'assets.md'], + ['block_manager/index.js', 'block_manager.md'], + ['commands/index.js', 'commands.md'], + ['dom_components/index.js', 'components.md'], + ['panels/index.js', 'panels.md'], + ['style_manager/index.js', 'style_manager.md'], + ['storage_manager/index.js', 'storage_manager.md'], + ['device_manager/index.js', 'device_manager.md'], + ['selector_manager/index.js', 'selector_manager.md'], + ['css_composer/index.js', 'css_composer.md'], + ['modal_dialog/index.js', 'modal_dialog.md'], + ['rich_text_editor/index.js', 'rich_text_editor.md'], + ['keymaps/index.js', 'keymaps.md'], + ['undo_manager/index.js', 'undo_manager.md'], ].map(entry => `${binRoot}documentation build ${srcRoot}/${entry[0]} -o ${docRoot}/api/${entry[1]} -f md --shallow --markdown-toc false`) .join(' && '); diff --git a/docs/api/README.md b/docs/api/README.md index 1ffb3c276..49d55ffef 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -1,8 +1,7 @@ --- pageClass: page__apis -editLink: false --- # API Reference -Here you'll find the documentation about GrapesJS's APIs +Here you can find the documentation about GrapesJS' APIs. Mainly, you would use them for your editor to extend the basic functionality of the framework or you could also [create a plugin](/modules/Plugins.html) and make those extensions reusable and available to others. diff --git a/package.json b/package.json index d6f096a5d..10cedc1cf 100644 --- a/package.json +++ b/package.json @@ -92,7 +92,7 @@ "scripts": { "docs:api": "node docs/api.js", "docs:dev": "vuepress dev docs", - "docs:build": "vuepress build docs", + "docs:build": "npm run docs:api && vuepress build docs", "lint": "eslint src", "check": "npm run lint && npm run test", "precommit": "lint-staged",