Set up auto-docs

WordPress · Mar 6, 2019 · a228d67 · a228d67
1 parent aac483d
commit a228d67
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 7 deletions.
diff --git a/bin/update-readmes.js b/bin/update-readmes.js
@@ -7,7 +7,7 @@ const packages = [
  //'a11y',
  //'autop',
  //'blob',
- //'block-editor',
+ 'block-editor',
  //'block-library',
  //'block-serialization-default-parser',
  //'blocks',

diff --git a/packages/block-editor/README.md b/packages/block-editor/README.md
@@ -22,6 +22,27 @@ _This package assumes that your code will run in an **ES2015+** environment. If
 
 Undocumented declaration.
 
+### SETTINGS_DEFAULTS
+
+[src/index.js#L13-L13](src/index.js#L13-L13)
+
+The default editor settings
+
+ alignWide boolean Enable/Disable Wide/Full Alignments
+ colors Array Palette colors
+ disableCustomColors boolean Whether or not the custom colors are disabled
+ fontSizes Array Available font sizes
+ disableCustomFontSizes boolean Whether or not the custom font sizes are disabled
+ imageSizes Array Available image sizes
+ maxWidth number Max width to constraint resizing
+ allowedBlockTypes boolean|Array Allowed block types
+ hasFixedToolbar boolean Whether or not the editor toolbar is fixed
+ focusMode boolean Whether the focus mode is enabled or not
+ styles Array Editor Styles
+ isRTL boolean Whether the editor is in RTL mode
+ bodyPlaceholder string Empty post placeholder
+ titlePlaceholder string Empty title placeholder
+
 
 <!-- END TOKEN(Autogenerated API docs) -->
 

diff --git a/packages/block-editor/package.json b/packages/block-editor/package.json
@@ -33,13 +33,7 @@
  "refx": "^3.0.0",
  "rememo": "^3.0.0"
  },
- "devDependencies": {
- "@wordpress/docgen": "file:../docgen"
- },
  "publishConfig": {
  "access": "public"
- },
- "scripts": {
- "docs:generate": "docgen ./src/index.js --output ./README.md --to-token"
  }
 }