docs: add TableStyleSpecs image in various places

native-html · Oct 1, 2020 · 0e88b30 · 0e88b30
1 parent 77ee4e7
commit 0e88b30
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 5 deletions.
diff --git a/docs/table-plugin.defaulttablestylesspecs.md b/docs/table-plugin.defaulttablestylesspecs.md
@@ -6,6 +6,8 @@
 
 Default styles attributes.
 
+<img src="https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png" />
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/table-plugin.md b/docs/table-plugin.md
@@ -24,13 +24,13 @@
 |  [TableAccurateContentHeightState](./table-plugin.tableaccuratecontentheightstate.md) | This content height state appears when the real table height is available, after the DOM has been mounted in the <code>WebView</code>. |
 |  [TableConfig](./table-plugin.tableconfig.md) | This object defines how the table component can be customized. |
 |  [TableHeuristicContentHeightState](./table-plugin.tableheuristiccontentheightstate.md) | This content height state is available on mount, before the real height is known from the DOM. |
-|  [TableStyleSpecs](./table-plugin.tablestylespecs.md) | An object describing how to generate styles. See [cssRulesFromSpecs()](./table-plugin.cssrulesfromspecs.md)<!-- -->.<!-- -->!\[\](https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png) |
+|  [TableStyleSpecs](./table-plugin.tablestylespecs.md) | An object describing how to generate styles. See [cssRulesFromSpecs()](./table-plugin.cssrulesfromspecs.md)<!-- -->.<img src="https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png" /> |
 
 ## Variables
 
 |  Variable | Description |
 |  --- | --- |
-|  [defaultTableStylesSpecs](./table-plugin.defaulttablestylesspecs.md) | Default styles attributes. |
+|  [defaultTableStylesSpecs](./table-plugin.defaulttablestylesspecs.md) | Default styles attributes.<img src="https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png" /> |
 |  [IGNORED\_TAGS](./table-plugin.ignored_tags.md) | A new list of tags to ignore, which exclude [TABLE\_TAGS](./table-plugin.table_tags.md)<!-- -->. |
 |  [TABLE\_TAGS](./table-plugin.table_tags.md) | All HTML tags associated with a table element. |
 

diff --git a/docs/table-plugin.tableconfig.md b/docs/table-plugin.tableconfig.md
@@ -23,7 +23,7 @@ export interface TableConfig<WebViewProps = any>
 |  [cssRules](./table-plugin.tableconfig.cssrules.md) | string | Override default CSS rules with this prop. |
 |  [sourceBaseUrl](./table-plugin.tableconfig.sourcebaseurl.md) | string | See https://git.io/JeCAG |
 |  [style](./table-plugin.tableconfig.style.md) | StyleProp&lt;ViewStyle&gt; | Container style. |
-|  [tableStyleSpecs](./table-plugin.tableconfig.tablestylespecs.md) | [TableStyleSpecs](./table-plugin.tablestylespecs.md) | Specs to generate css rules. |
+|  [tableStyleSpecs](./table-plugin.tableconfig.tablestylespecs.md) | [TableStyleSpecs](./table-plugin.tablestylespecs.md) | Specs to generate css rules.<img src="https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png" /> |
 |  [WebView](./table-plugin.tableconfig.webview.md) | ComponentType&lt;WebViewProps&gt; | The <code>WebView</code> Component you wish to use. |
 |  [webViewProps](./table-plugin.tableconfig.webviewprops.md) | WebViewProps | Any props you'd like to pass to [TableConfig.WebView](./table-plugin.tableconfig.webview.md)<!-- -->. |
 
diff --git a/docs/table-plugin.tableconfig.tablestylespecs.md b/docs/table-plugin.tableconfig.tablestylespecs.md
@@ -6,6 +6,8 @@
 
 Specs to generate css rules.
 
+<img src="https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png" />
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/table-plugin.tablestylespecs.md b/docs/table-plugin.tablestylespecs.md
@@ -6,7 +6,7 @@
 
 An object describing how to generate styles. See [cssRulesFromSpecs()](./table-plugin.cssrulesfromspecs.md)<!-- -->.
 
-!\[\](https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png)
+<img src="https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png" />
 
 <b>Signature:</b>
 

diff --git a/table-plugin/src/css-rules.ts b/table-plugin/src/css-rules.ts
@@ -3,6 +3,8 @@ import { TableStyleSpecs } from './types';
 /**
  * Default styles attributes.
  *
+ * <img src="https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png" />
+ *
  * @remarks
  * Custom attributes will be shallow-merged.
  *

diff --git a/table-plugin/src/types.ts b/table-plugin/src/types.ts
@@ -4,7 +4,7 @@ import { StyleProp, ViewStyle } from 'react-native';
 /**
  * An object describing how to generate styles. See {@link cssRulesFromSpecs}.
  *
- * ![](https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png)
+ * <img src="https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png" />
  *
  * @public
  */
@@ -239,6 +239,8 @@ export interface TableConfig<WebViewProps = any> {
   /**
    * Specs to generate css rules.
    *
+   * <img src="https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png" />
+   *
    * @remarks
    * This prop will be ignored when `cssRules` are provided.
    */