Skip to content

Commit 59d74f5

Browse files
author
farfromrefuge
committed
readme/doc
1 parent 9f0b6f7 commit 59d74f5

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/ui_pager.Pager.html

Lines changed: 3 additions & 1 deletion
Large diffs are not rendered by default.

docs/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -325,31 +325,31 @@ <h1 align="center">@nativescript-community/ui-pager-indicator</h1>
325325
if you use <code>pnpm</code> then run <code>pnpm i</code></p>
326326
<p><strong>Interactive Menu:</strong></p>
327327
<p>To start the interactive menu, run <code>npm start</code> (or <code>yarn start</code> or <code>pnpm start</code>). This will list all of the commonly used scripts.</p>
328-
<a id="md:build" class="tsd-anchor"></a><h3><a href="#md:build">Build</a></h3><pre><code class="language-bash"><span class="hl-1">npm </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">build.all</span>
328+
<a id="md:build" class="tsd-anchor"></a><h3><a href="#md:build">Build</a></h3><pre><code class="language-bash"><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">build.all</span>
329329
</code><button>Copy</button></pre>
330330
<p>WARNING: it seems <code>yarn build.all</code> wont always work (not finding binaries in <code>node_modules/.bin</code>) which is why the doc explicitly uses <code>npm run</code></p>
331-
<a id="md:demos" class="tsd-anchor"></a><h3><a href="#md:demos">Demos</a></h3><pre><code class="language-bash"><span class="hl-1">npm </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">demo.[ng</span><span class="hl-1">|react|svelte|vue].[ios|android]</span><br/><br/><span class="hl-1">npm </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">demo.svelte.ios</span><span class="hl-1"> </span><span class="hl-11"># Example</span>
331+
<a id="md:demos" class="tsd-anchor"></a><h3><a href="#md:demos">Demos</a></h3><pre><code class="language-bash"><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">demo.[ng</span><span class="hl-1">|</span><span class="hl-6">react</span><span class="hl-1">|</span><span class="hl-6">svelte</span><span class="hl-1">|</span><span class="hl-6">vue].[ios</span><span class="hl-1">|</span><span class="hl-6">android]</span><br/><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">demo.svelte.ios</span><span class="hl-1"> </span><span class="hl-11"># Example</span>
332332
</code><button>Copy</button></pre>
333333
<p>Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in <code>demo-[ng|react|svelte|vue]</code>
334334
Instead you work in <code>demo-snippets/[ng|react|svelte|vue]</code>
335335
You can start from the <code>install.ts</code> of each flavor to see how to register new demos </p>
336336
<p><a href="#md:contributing"></a></p>
337337
<a id="md:contributing" class="tsd-anchor"></a><h2><a href="#md:contributing">Contributing</a></h2><a id="md:update-repo" class="tsd-anchor"></a><h3><a href="#md:update-repo">Update repo</a></h3><p>You can update the repo files quite easily</p>
338338
<p>First update the submodules</p>
339-
<pre><code class="language-bash"><span class="hl-1">npm </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">update</span>
339+
<pre><code class="language-bash"><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">update</span>
340340
</code><button>Copy</button></pre>
341341
<p>Then commit the changes
342342
Then update common files</p>
343-
<pre><code class="language-bash"><span class="hl-1">npm </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">sync</span>
343+
<pre><code class="language-bash"><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">sync</span>
344344
</code><button>Copy</button></pre>
345345
<p>Then you can run <code>yarn|pnpm</code>, commit changed files if any</p>
346-
<a id="md:update-readme" class="tsd-anchor"></a><h3><a href="#md:update-readme">Update readme</a></h3><pre><code class="language-bash"><span class="hl-1">npm </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">readme</span>
346+
<a id="md:update-readme" class="tsd-anchor"></a><h3><a href="#md:update-readme">Update readme</a></h3><pre><code class="language-bash"><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">readme</span>
347347
</code><button>Copy</button></pre>
348-
<a id="md:update-doc" class="tsd-anchor"></a><h3><a href="#md:update-doc">Update doc</a></h3><pre><code class="language-bash"><span class="hl-1">npm </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">doc</span>
348+
<a id="md:update-doc" class="tsd-anchor"></a><h3><a href="#md:update-doc">Update doc</a></h3><pre><code class="language-bash"><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">doc</span>
349349
</code><button>Copy</button></pre>
350350
<a id="md:publish" class="tsd-anchor"></a><h3><a href="#md:publish">Publish</a></h3><p>The publishing is completely handled by <code>lerna</code> (you can add <code>-- --bump major</code> to force a major release)
351351
Simply run </p>
352-
<pre><code class="language-shell"><span class="hl-1">npm </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">publish</span>
352+
<pre><code class="language-shell"><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">publish</span>
353353
</code><button>Copy</button></pre>
354354
<a id="md:modifying-submodules" class="tsd-anchor"></a><h3><a href="#md:modifying-submodules">modifying submodules</a></h3><p>The repo uses https:// for submodules which means you won&#39;t be able to push directly into the submodules.
355355
One easy solution is t modify <code>~/.gitconfig</code> and add</p>

0 commit comments

Comments
 (0)