Browse Source

More updates for API in docs

docs
Artur Arseniev 8 years ago
parent
commit
63f9ca29fc
  1. 28
      docs/api.js
  2. 3
      docs/api/README.md
  3. 2
      package.json

28
docs/api.js

@ -6,20 +6,20 @@ const srcRoot = path.join(docRoot, '../src/');
const binRoot = path.join(docRoot, '../node_modules/.bin/'); const binRoot = path.join(docRoot, '../node_modules/.bin/');
const cmds = [ const cmds = [
['editor/index.js', 'editor.md'], ['editor/index.js', 'editor.md'],
//['asset_manager/index.js', 'assets.md'], ['asset_manager/index.js', 'assets.md'],
//['block_manager/index.js', 'block_manager.md'], ['block_manager/index.js', 'block_manager.md'],
//['commands/index.js', 'commands.md'], ['commands/index.js', 'commands.md'],
//['dom_components/index.js', 'components.md'], ['dom_components/index.js', 'components.md'],
//['panels/index.js', 'panels.md'], ['panels/index.js', 'panels.md'],
//['style_manager/index.js', 'style_manager.md'], ['style_manager/index.js', 'style_manager.md'],
//['storage_manager/index.js', 'storage_manager.md'], ['storage_manager/index.js', 'storage_manager.md'],
//['device_manager/index.js', 'device_manager.md'], ['device_manager/index.js', 'device_manager.md'],
//['selector_manager/index.js', 'selector_manager.md'], ['selector_manager/index.js', 'selector_manager.md'],
//['css_composer/index.js', 'css_composer.md'], ['css_composer/index.js', 'css_composer.md'],
//['modal_dialog/index.js', 'modal_dialog.md'], ['modal_dialog/index.js', 'modal_dialog.md'],
//['rich_text_editor/index.js', 'rich_text_editor.md'], ['rich_text_editor/index.js', 'rich_text_editor.md'],
//['keymaps/index.js', 'keymaps.md'], ['keymaps/index.js', 'keymaps.md'],
//['undo_manager/index.js', 'undo_manager.md'], ['undo_manager/index.js', 'undo_manager.md'],
].map(entry => ].map(entry =>
`${binRoot}documentation build ${srcRoot}/${entry[0]} -o ${docRoot}/api/${entry[1]} -f md --shallow --markdown-toc false`) `${binRoot}documentation build ${srcRoot}/${entry[0]} -o ${docRoot}/api/${entry[1]} -f md --shallow --markdown-toc false`)
.join(' && '); .join(' && ');

3
docs/api/README.md

@ -1,8 +1,7 @@
--- ---
pageClass: page__apis pageClass: page__apis
editLink: false
--- ---
# API Reference # 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.

2
package.json

@ -92,7 +92,7 @@
"scripts": { "scripts": {
"docs:api": "node docs/api.js", "docs:api": "node docs/api.js",
"docs:dev": "vuepress dev docs", "docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs", "docs:build": "npm run docs:api && vuepress build docs",
"lint": "eslint src", "lint": "eslint src",
"check": "npm run lint && npm run test", "check": "npm run lint && npm run test",
"precommit": "lint-staged", "precommit": "lint-staged",

Loading…
Cancel
Save