Skip to content

Commit

Permalink
Remove/docgen url symbol (#14656)
Browse files Browse the repository at this point in the history 
It suffers from a few problems:

- relative URLs don't work on Gutenberg handbook and npm packages
- the <> is escaped so is rendered in a weird way that looks like
  an error
  • Loading branch information
@nosolosw
nosolosw authored Mar 27, 2019
1 parent ac06e57 commit 557dca7
Show file tree
Hide file tree
Showing 30 changed files with 356 additions and 369 deletions.
4 changes: 2 additions & 2 deletions packages/a11y/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ _This package assumes that your code will run in an **ES2015+** environment. If

<!-- START TOKEN(Autogenerated API docs) -->

<a name="setup" href="#setup">#</a> **setup** [\<>](src/index.js#L16-L26)
<a name="setup" href="#setup">#</a> **setup**

Create the live regions.

<a name="speak" href="#speak">#</a> **speak** [\<>](src/index.js#L52-L66)
<a name="speak" href="#speak">#</a> **speak**

Allows you to easily announce dynamic interface updates to screen readers using ARIA live regions.
This module is inspired by the `speak` function in wp-a11y.js
Expand Down
4 changes: 2 additions & 2 deletions packages/autop/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ _This package assumes that your code will run in an **ES2015+** environment. If

<!-- START TOKEN(Autogenerated API docs) -->

<a name="autop" href="#autop">#</a> **autop** [\<>](src/index.js#L129-L285)
<a name="autop" href="#autop">#</a> **autop**

Replaces double line-breaks with paragraph elements.

Expand All @@ -40,7 +40,7 @@ _Returns_

- `string`: Text which has been converted into paragraph tags.

<a name="removep" href="#removep">#</a> **removep** [\<>](src/index.js#L303-L426)
<a name="removep" href="#removep">#</a> **removep**

Replaces `<p>` tags with two line breaks. "Opposite" of autop().

Expand Down
8 changes: 4 additions & 4 deletions packages/blob/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ npm install @wordpress/blob --save

<!-- START TOKEN(Autogenerated API docs) -->

<a name="createBlobURL" href="#createBlobURL">#</a> **createBlobURL** [\<>](src/index.js#L15-L21)
<a name="createBlobURL" href="#createBlobURL">#</a> **createBlobURL**

Create a blob URL from a file.

Expand All @@ -26,7 +26,7 @@ _Returns_

- `string`: The blob URL.

<a name="getBlobByURL" href="#getBlobByURL">#</a> **getBlobByURL** [\<>](src/index.js#L32-L34)
<a name="getBlobByURL" href="#getBlobByURL">#</a> **getBlobByURL**

Retrieve a file based on a blob URL. The file must have been created by
`createBlobURL` and not removed by `revokeBlobURL`, otherwise it will return
Expand All @@ -40,7 +40,7 @@ _Returns_

- `?File`: The file for the blob URL.

<a name="isBlobURL" href="#isBlobURL">#</a> **isBlobURL** [\<>](src/index.js#L56-L61)
<a name="isBlobURL" href="#isBlobURL">#</a> **isBlobURL**

Check whether a url is a blob url.

Expand All @@ -52,7 +52,7 @@ _Returns_

- `boolean`: Is the url a blob url?

<a name="revokeBlobURL" href="#revokeBlobURL">#</a> **revokeBlobURL** [\<>](src/index.js#L41-L47)
<a name="revokeBlobURL" href="#revokeBlobURL">#</a> **revokeBlobURL**

Remove the resource and file cache from memory.

Expand Down
112 changes: 56 additions & 56 deletions packages/block-editor/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,91 +68,91 @@ registerCoreBlockTypes();

<!-- START TOKEN(Autogenerated API docs) -->

<a name="AlignmentToolbar" href="#AlignmentToolbar">#</a> **AlignmentToolbar** [\<>](src/index.js#L15-L15)
<a name="AlignmentToolbar" href="#AlignmentToolbar">#</a> **AlignmentToolbar**

Undocumented declaration.

<a name="Autocomplete" href="#Autocomplete">#</a> **Autocomplete** [\<>](src/index.js#L15-L15)
<a name="Autocomplete" href="#Autocomplete">#</a> **Autocomplete**

Undocumented declaration.

<a name="BlockAlignmentToolbar" href="#BlockAlignmentToolbar">#</a> **BlockAlignmentToolbar** [\<>](src/index.js#L15-L15)
<a name="BlockAlignmentToolbar" href="#BlockAlignmentToolbar">#</a> **BlockAlignmentToolbar**

Undocumented declaration.

<a name="BlockControls" href="#BlockControls">#</a> **BlockControls** [\<>](src/index.js#L15-L15)
<a name="BlockControls" href="#BlockControls">#</a> **BlockControls**

Undocumented declaration.

<a name="BlockEdit" href="#BlockEdit">#</a> **BlockEdit** [\<>](src/index.js#L15-L15)
<a name="BlockEdit" href="#BlockEdit">#</a> **BlockEdit**

Undocumented declaration.

<a name="BlockEditorKeyboardShortcuts" href="#BlockEditorKeyboardShortcuts">#</a> **BlockEditorKeyboardShortcuts** [\<>](src/index.js#L15-L15)
<a name="BlockEditorKeyboardShortcuts" href="#BlockEditorKeyboardShortcuts">#</a> **BlockEditorKeyboardShortcuts**

Undocumented declaration.

<a name="BlockEditorProvider" href="#BlockEditorProvider">#</a> **BlockEditorProvider** [\<>](src/index.js#L15-L15)
<a name="BlockEditorProvider" href="#BlockEditorProvider">#</a> **BlockEditorProvider**

Undocumented declaration.

<a name="BlockFormatControls" href="#BlockFormatControls">#</a> **BlockFormatControls** [\<>](src/index.js#L15-L15)
<a name="BlockFormatControls" href="#BlockFormatControls">#</a> **BlockFormatControls**

Undocumented declaration.

<a name="BlockIcon" href="#BlockIcon">#</a> **BlockIcon** [\<>](src/index.js#L15-L15)
<a name="BlockIcon" href="#BlockIcon">#</a> **BlockIcon**

Undocumented declaration.

<a name="BlockInspector" href="#BlockInspector">#</a> **BlockInspector** [\<>](src/index.js#L15-L15)
<a name="BlockInspector" href="#BlockInspector">#</a> **BlockInspector**

Undocumented declaration.

<a name="BlockList" href="#BlockList">#</a> **BlockList** [\<>](src/index.js#L15-L15)
<a name="BlockList" href="#BlockList">#</a> **BlockList**

Undocumented declaration.

<a name="BlockMover" href="#BlockMover">#</a> **BlockMover** [\<>](src/index.js#L15-L15)
<a name="BlockMover" href="#BlockMover">#</a> **BlockMover**

Undocumented declaration.

<a name="BlockNavigationDropdown" href="#BlockNavigationDropdown">#</a> **BlockNavigationDropdown** [\<>](src/index.js#L15-L15)
<a name="BlockNavigationDropdown" href="#BlockNavigationDropdown">#</a> **BlockNavigationDropdown**

Undocumented declaration.

<a name="BlockSelectionClearer" href="#BlockSelectionClearer">#</a> **BlockSelectionClearer** [\<>](src/index.js#L15-L15)
<a name="BlockSelectionClearer" href="#BlockSelectionClearer">#</a> **BlockSelectionClearer**

Undocumented declaration.

<a name="BlockSettingsMenu" href="#BlockSettingsMenu">#</a> **BlockSettingsMenu** [\<>](src/index.js#L15-L15)
<a name="BlockSettingsMenu" href="#BlockSettingsMenu">#</a> **BlockSettingsMenu**

Undocumented declaration.

<a name="BlockTitle" href="#BlockTitle">#</a> **BlockTitle** [\<>](src/index.js#L15-L15)
<a name="BlockTitle" href="#BlockTitle">#</a> **BlockTitle**

Undocumented declaration.

<a name="BlockToolbar" href="#BlockToolbar">#</a> **BlockToolbar** [\<>](src/index.js#L15-L15)
<a name="BlockToolbar" href="#BlockToolbar">#</a> **BlockToolbar**

Undocumented declaration.

<a name="BlockVerticalAlignmentToolbar" href="#BlockVerticalAlignmentToolbar">#</a> **BlockVerticalAlignmentToolbar** [\<>](src/index.js#L15-L15)
<a name="BlockVerticalAlignmentToolbar" href="#BlockVerticalAlignmentToolbar">#</a> **BlockVerticalAlignmentToolbar**

Undocumented declaration.

<a name="ColorPalette" href="#ColorPalette">#</a> **ColorPalette** [\<>](src/index.js#L15-L15)
<a name="ColorPalette" href="#ColorPalette">#</a> **ColorPalette**

Undocumented declaration.

<a name="ContrastChecker" href="#ContrastChecker">#</a> **ContrastChecker** [\<>](src/index.js#L15-L15)
<a name="ContrastChecker" href="#ContrastChecker">#</a> **ContrastChecker**

Undocumented declaration.

<a name="CopyHandler" href="#CopyHandler">#</a> **CopyHandler** [\<>](src/index.js#L15-L15)
<a name="CopyHandler" href="#CopyHandler">#</a> **CopyHandler**

Undocumented declaration.

<a name="createCustomColorsHOC" href="#createCustomColorsHOC">#</a> **createCustomColorsHOC** [\<>](src/index.js#L15-L15)
<a name="createCustomColorsHOC" href="#createCustomColorsHOC">#</a> **createCustomColorsHOC**

A higher-order component factory for creating a 'withCustomColors' HOC, which handles color logic
for class generation color value, retrieval and color attribute setting.
Expand All @@ -179,15 +179,15 @@ _Returns_

- `Function`: Higher-order component.

<a name="DefaultBlockAppender" href="#DefaultBlockAppender">#</a> **DefaultBlockAppender** [\<>](src/index.js#L15-L15)
<a name="DefaultBlockAppender" href="#DefaultBlockAppender">#</a> **DefaultBlockAppender**

Undocumented declaration.

<a name="FontSizePicker" href="#FontSizePicker">#</a> **FontSizePicker** [\<>](src/index.js#L15-L15)
<a name="FontSizePicker" href="#FontSizePicker">#</a> **FontSizePicker**

Undocumented declaration.

<a name="getColorClassName" href="#getColorClassName">#</a> **getColorClassName** [\<>](src/index.js#L15-L15)
<a name="getColorClassName" href="#getColorClassName">#</a> **getColorClassName**

Returns a class based on the context a color is being used and its slug.

Expand All @@ -200,7 +200,7 @@ _Returns_

- `string`: String with the class corresponding to the color in the provided context.

<a name="getColorObjectByAttributeValues" href="#getColorObjectByAttributeValues">#</a> **getColorObjectByAttributeValues** [\<>](src/index.js#L15-L15)
<a name="getColorObjectByAttributeValues" href="#getColorObjectByAttributeValues">#</a> **getColorObjectByAttributeValues**

Provided an array of color objects as set by the theme or by the editor defaults,
and the values of the defined color or custom color returns a color object describing the color.
Expand All @@ -215,7 +215,7 @@ _Returns_

- `?string`: If definedColor is passed and the name is found in colors, the color object exactly as set by the theme or editor defaults is returned. Otherwise, an object that just sets the color is defined.

<a name="getColorObjectByColorValue" href="#getColorObjectByColorValue">#</a> **getColorObjectByColorValue** [\<>](src/index.js#L15-L15)
<a name="getColorObjectByColorValue" href="#getColorObjectByColorValue">#</a> **getColorObjectByColorValue**

Provided an array of color objects as set by the theme or by the editor defaults, and a color value returns the color object matching that value or undefined.

Expand All @@ -228,7 +228,7 @@ _Returns_

- `?string`: Returns the color object included in the colors array whose color property equals colorValue. Returns undefined if no color object matches this requirement.

<a name="getFontSize" href="#getFontSize">#</a> **getFontSize** [\<>](src/index.js#L15-L15)
<a name="getFontSize" href="#getFontSize">#</a> **getFontSize**

Returns the font size object based on an array of named font sizes and the namedFontSize and customFontSize values.
If namedFontSize is undefined or not found in fontSizes an object with just the size value based on customFontSize is returned.
Expand All @@ -243,7 +243,7 @@ _Returns_

- `?string`: If fontSizeAttribute is set and an equal slug is found in fontSizes it returns the font size object for that slug. Otherwise, an object with just the size value based on customFontSize is returned.

<a name="getFontSizeClass" href="#getFontSizeClass">#</a> **getFontSizeClass** [\<>](src/index.js#L15-L15)
<a name="getFontSizeClass" href="#getFontSizeClass">#</a> **getFontSizeClass**

Returns a class based on fontSizeName.

Expand All @@ -255,75 +255,75 @@ _Returns_

- `string`: String with the class corresponding to the fontSize passed. The class is generated by appending 'has-' followed by fontSizeSlug in kebabCase and ending with '-font-size'.

<a name="InnerBlocks" href="#InnerBlocks">#</a> **InnerBlocks** [\<>](src/index.js#L15-L15)
<a name="InnerBlocks" href="#InnerBlocks">#</a> **InnerBlocks**

Undocumented declaration.

<a name="Inserter" href="#Inserter">#</a> **Inserter** [\<>](src/index.js#L15-L15)
<a name="Inserter" href="#Inserter">#</a> **Inserter**

Undocumented declaration.

<a name="InspectorAdvancedControls" href="#InspectorAdvancedControls">#</a> **InspectorAdvancedControls** [\<>](src/index.js#L15-L15)
<a name="InspectorAdvancedControls" href="#InspectorAdvancedControls">#</a> **InspectorAdvancedControls**

Undocumented declaration.

<a name="InspectorControls" href="#InspectorControls">#</a> **InspectorControls** [\<>](src/index.js#L15-L15)
<a name="InspectorControls" href="#InspectorControls">#</a> **InspectorControls**

Undocumented declaration.

<a name="MediaPlaceholder" href="#MediaPlaceholder">#</a> **MediaPlaceholder** [\<>](src/index.js#L15-L15)
<a name="MediaPlaceholder" href="#MediaPlaceholder">#</a> **MediaPlaceholder**

Undocumented declaration.

<a name="MediaUpload" href="#MediaUpload">#</a> **MediaUpload** [\<>](src/index.js#L15-L15)
<a name="MediaUpload" href="#MediaUpload">#</a> **MediaUpload**

Undocumented declaration.

<a name="MediaUploadCheck" href="#MediaUploadCheck">#</a> **MediaUploadCheck** [\<>](src/index.js#L15-L15)
<a name="MediaUploadCheck" href="#MediaUploadCheck">#</a> **MediaUploadCheck**

Undocumented declaration.

<a name="MultiBlocksSwitcher" href="#MultiBlocksSwitcher">#</a> **MultiBlocksSwitcher** [\<>](src/index.js#L15-L15)
<a name="MultiBlocksSwitcher" href="#MultiBlocksSwitcher">#</a> **MultiBlocksSwitcher**

Undocumented declaration.

<a name="MultiSelectScrollIntoView" href="#MultiSelectScrollIntoView">#</a> **MultiSelectScrollIntoView** [\<>](src/index.js#L15-L15)
<a name="MultiSelectScrollIntoView" href="#MultiSelectScrollIntoView">#</a> **MultiSelectScrollIntoView**

Undocumented declaration.

<a name="NavigableToolbar" href="#NavigableToolbar">#</a> **NavigableToolbar** [\<>](src/index.js#L15-L15)
<a name="NavigableToolbar" href="#NavigableToolbar">#</a> **NavigableToolbar**

Undocumented declaration.

<a name="ObserveTyping" href="#ObserveTyping">#</a> **ObserveTyping** [\<>](src/index.js#L15-L15)
<a name="ObserveTyping" href="#ObserveTyping">#</a> **ObserveTyping**

Undocumented declaration.

<a name="PanelColorSettings" href="#PanelColorSettings">#</a> **PanelColorSettings** [\<>](src/index.js#L15-L15)
<a name="PanelColorSettings" href="#PanelColorSettings">#</a> **PanelColorSettings**

Undocumented declaration.

<a name="PlainText" href="#PlainText">#</a> **PlainText** [\<>](src/index.js#L15-L15)
<a name="PlainText" href="#PlainText">#</a> **PlainText**

Undocumented declaration.

<a name="PreserveScrollInReorder" href="#PreserveScrollInReorder">#</a> **PreserveScrollInReorder** [\<>](src/index.js#L15-L15)
<a name="PreserveScrollInReorder" href="#PreserveScrollInReorder">#</a> **PreserveScrollInReorder**

Undocumented declaration.

<a name="RichText" href="#RichText">#</a> **RichText** [\<>](src/index.js#L15-L15)
<a name="RichText" href="#RichText">#</a> **RichText**

Undocumented declaration.

<a name="RichTextShortcut" href="#RichTextShortcut">#</a> **RichTextShortcut** [\<>](src/index.js#L15-L15)
<a name="RichTextShortcut" href="#RichTextShortcut">#</a> **RichTextShortcut**

Undocumented declaration.

<a name="RichTextToolbarButton" href="#RichTextToolbarButton">#</a> **RichTextToolbarButton** [\<>](src/index.js#L15-L15)
<a name="RichTextToolbarButton" href="#RichTextToolbarButton">#</a> **RichTextToolbarButton**

Undocumented declaration.

<a name="SETTINGS_DEFAULTS" href="#SETTINGS_DEFAULTS">#</a> **SETTINGS_DEFAULTS** [\<>](src/index.js#L17-L17)
<a name="SETTINGS_DEFAULTS" href="#SETTINGS_DEFAULTS">#</a> **SETTINGS_DEFAULTS**

The default editor settings

Expand All @@ -344,31 +344,31 @@ The default editor settings
bodyPlaceholder string Empty post placeholder
titlePlaceholder string Empty title placeholder

<a name="SkipToSelectedBlock" href="#SkipToSelectedBlock">#</a> **SkipToSelectedBlock** [\<>](src/index.js#L15-L15)
<a name="SkipToSelectedBlock" href="#SkipToSelectedBlock">#</a> **SkipToSelectedBlock**

Undocumented declaration.

<a name="URLInput" href="#URLInput">#</a> **URLInput** [\<>](src/index.js#L15-L15)
<a name="URLInput" href="#URLInput">#</a> **URLInput**

Undocumented declaration.

<a name="URLInputButton" href="#URLInputButton">#</a> **URLInputButton** [\<>](src/index.js#L15-L15)
<a name="URLInputButton" href="#URLInputButton">#</a> **URLInputButton**

Undocumented declaration.

<a name="URLPopover" href="#URLPopover">#</a> **URLPopover** [\<>](src/index.js#L15-L15)
<a name="URLPopover" href="#URLPopover">#</a> **URLPopover**

Undocumented declaration.

<a name="Warning" href="#Warning">#</a> **Warning** [\<>](src/index.js#L15-L15)
<a name="Warning" href="#Warning">#</a> **Warning**

Undocumented declaration.

<a name="withColorContext" href="#withColorContext">#</a> **withColorContext** [\<>](src/index.js#L15-L15)
<a name="withColorContext" href="#withColorContext">#</a> **withColorContext**

Undocumented declaration.

<a name="withColors" href="#withColors">#</a> **withColors** [\<>](src/index.js#L15-L15)
<a name="withColors" href="#withColors">#</a> **withColors**

A higher-order component, which handles color logic for class generation color value, retrieval and color attribute setting.

Expand All @@ -391,7 +391,7 @@ _Returns_

- `Function`: Higher-order component.

<a name="withFontSizes" href="#withFontSizes">#</a> **withFontSizes** [\<>](src/index.js#L15-L15)
<a name="withFontSizes" href="#withFontSizes">#</a> **withFontSizes**

Higher-order component, which handles font size logic for class generation,
font size value retrieval, and font size change handling.
Expand All @@ -404,7 +404,7 @@ _Returns_

- `Function`: Higher-order component.

<a name="WritingFlow" href="#WritingFlow">#</a> **WritingFlow** [\<>](src/index.js#L15-L15)
<a name="WritingFlow" href="#WritingFlow">#</a> **WritingFlow**

Undocumented declaration.

Expand Down
2 changes: 1 addition & 1 deletion packages/block-library/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ _This package assumes that your code will run in an **ES2015+** environment. If

<!-- START TOKEN(Autogenerated API docs) -->

<a name="registerCoreBlocks" href="#registerCoreBlocks">#</a> **registerCoreBlocks** [\<>](src/index.js#L70-L132)
<a name="registerCoreBlocks" href="#registerCoreBlocks">#</a> **registerCoreBlocks**

Function to register core blocks provided by the block editor.

Expand Down
Loading

0 comments on commit 557dca7

Please sign in to comment.