Skip to content

Commit

Permalink
chore: update docs (#166)
Browse files Browse the repository at this point in the history
  • Loading branch information
JimmyDaddy authored Nov 29, 2023
1 parent 532e8a4 commit fd1aead
Show file tree
Hide file tree
Showing 16 changed files with 96 additions and 95 deletions.
6 changes: 3 additions & 3 deletions docs/latest/classes/Marker.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Marker</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L825">index.ts:825</a></li></ul></aside>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L825">index.ts:825</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -53,7 +53,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-4">const</span><s
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L978">index.ts:978</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L978">index.ts:978</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="markText" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>mark<wbr/>Text</span><a href="#markText" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -74,7 +74,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-4">const</span><s
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L910">index.ts:910</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L910">index.ts:910</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
8 changes: 4 additions & 4 deletions docs/latest/enums/ImageFormat.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h1>Enumeration ImageFormat</h1></div>
<h4>Description</h4><p>ImageFormat enum for save image format</p>
</div></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L38">index.ts:38</a></li></ul></aside>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L38">index.ts:38</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -38,17 +38,17 @@ <h2>Enumeration Members</h2>
<h3 class="tsd-anchor-link"><span>base64</span><a href="#base64" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">base64</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;base64&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L42">index.ts:42</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L42">index.ts:42</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="jpg" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>jpg</span><a href="#jpg" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">jpg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;jpg&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L40">index.ts:40</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L40">index.ts:40</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="png" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>png</span><a href="#png" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">png</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;png&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L39">index.ts:39</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L39">index.ts:39</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
16 changes: 8 additions & 8 deletions docs/latest/enums/Position.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h1>Enumeration Position</h1></div>
<h4>Description</h4><p>Position enum for text watermark and image watermark</p>
</div></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L14">index.ts:14</a></li></ul></aside>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L14">index.ts:14</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -42,37 +42,37 @@ <h2>Enumeration Members</h2>
<h3 class="tsd-anchor-link"><span>bottom<wbr/>Center</span><a href="#bottomCenter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">bottom<wbr/>Center</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;bottomCenter&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L19">index.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L19">index.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="bottomLeft" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>bottom<wbr/>Left</span><a href="#bottomLeft" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">bottom<wbr/>Left</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;bottomLeft&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L18">index.ts:18</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L18">index.ts:18</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="bottomRight" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>bottom<wbr/>Right</span><a href="#bottomRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">bottom<wbr/>Right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;bottomRight&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L20">index.ts:20</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L20">index.ts:20</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="center" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>center</span><a href="#center" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">center</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;center&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L21">index.ts:21</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L21">index.ts:21</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="topCenter" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>top<wbr/>Center</span><a href="#topCenter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">top<wbr/>Center</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;topCenter&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L16">index.ts:16</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L16">index.ts:16</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="topLeft" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>top<wbr/>Left</span><a href="#topLeft" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">top<wbr/>Left</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;topLeft&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L15">index.ts:15</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L15">index.ts:15</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="topRight" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>top<wbr/>Right</span><a href="#topRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">top<wbr/>Right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;topRight&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L17">index.ts:17</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L17">index.ts:17</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
8 changes: 4 additions & 4 deletions docs/latest/enums/TextBackgroundType.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h1>Enumeration TextBackgroundType</h1></div>
<h4>Description</h4><p>TextBackgroundType enum for text watermark</p>
</div></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L28">index.ts:28</a></li></ul></aside>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L28">index.ts:28</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -38,17 +38,17 @@ <h2>Enumeration Members</h2>
<h3 class="tsd-anchor-link"><span>none</span><a href="#none" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">none</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fit&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L31">index.ts:31</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L31">index.ts:31</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="stretchX" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>stretchX</span><a href="#stretchX" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">stretchX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stretchX&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L29">index.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L29">index.ts:29</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="stretchY" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>stretchY</span><a href="#stretchY" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">stretchY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stretchY&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/a942e30/src/index.ts#L30">index.ts:30</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/JimmyDaddy/react-native-image-marker/blob/532e8a4/src/index.ts#L30">index.ts:30</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
3 changes: 2 additions & 1 deletion docs/latest/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ <h6>Add text or icon watermarks to images</h6>
<div align="center">

<p> <a href="https://www.npmjs.com/package/react-native-image-marker"><img src="https://img.shields.io/npm/v/react-native-image-marker.svg?logo=npm" alt="npm version"></a> <a href="https://www.npmjs.com/package/react-native-image-marker"><img src="https://img.shields.io/npm/dm/react-native-image-marker?logo=npm" alt="npm"></a> <a href="https://github.com/JimmyDaddy/react-native-image-marker"><img src="https://img.shields.io/github/stars/jimmydaddy/react-native-image-marker?style=social" alt="stars"></a> <a href="https://github.com/JimmyDaddy/react-native-image-marker/fork"><img src="https://img.shields.io/github/forks/jimmydaddy/react-native-image-marker?style=social" alt="forks"></a><a href="https://github.com/JimmyDaddy/react-native-image-marker"><img src="https://img.shields.io/badge/github-repo-blue?logo=github" alt="github"></a> <a href="https://github.com/JimmyDaddy/react-native-image-marker/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?logo=github" alt="PRs Welcome"></a> <img src="https://img.shields.io/npm/l/react-native-image-marker" alt="license">
<img src="https://img.shields.io/badge/iOS-black?logo=Apple" alt="platform-iOS"> <img src="https://img.shields.io/badge/Android-black?logo=Android" alt="platform-Android">
<img src="https://img.shields.io/badge/iOS-black?logo=Apple" alt="platform-iOS"> <img src="https://img.shields.io/badge/Android-black?logo=Android" alt="platform-Android"> <a href="https://github.com/JimmyDaddy/react-native-image-marker/actions/workflows/native-ci.yml"><img src="https://github.com/JimmyDaddy/react-native-image-marker/actions/workflows/native-ci.yml/badge.svg" alt="Native Build and Test"></a>
<br/>
<em>If this library is useful to you, pls give me a ⭐️. 🤩</em></p>
</div>

Expand Down
Loading

0 comments on commit fd1aead

Please sign in to comment.