Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Soare-Robert-Daniel
Soare-Robert-Daniel committed Feb 2, 2021
1 parent 2c60815 commit 3bd306e
Show file tree
Hide file tree
Showing 30 changed files with 675 additions and 184 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

13 changes: 7 additions & 6 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>undefined</title>
<meta name="description" content="Documentation for undefined">
<title>logo-maker-plugin</title>
<meta name="description" content="Documentation for logo-maker-plugin">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
Expand All @@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">undefined</a>
<a href="index.html" class="title">logo-maker-plugin</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand All @@ -50,7 +50,7 @@
</div>
<div class="tsd-page-title">
<div class="container">
<h1>undefined</h1>
<h1>logo-maker-plugin</h1>
</div>
</div>
</header>
Expand All @@ -62,6 +62,7 @@ <h1>undefined</h1>
<h1>Logo Maker</h1>
</a>
<p>Logo Maker is a react app build with <a href="https://www.typescriptlang.org/">Typescript</a> created for designing simple logos.</p>
<p><img src="https://github.com/Codeinwp/logo-maker/workflows/Deploy%20on%20staging/badge.svg" alt="Main Build"></p>
<a href="#instalation-on-wordpress" id="instalation-on-wordpress" style="color: inherit; text-decoration: none;">
<h2>Instalation on Wordpress</h2>
</a>
Expand Down Expand Up @@ -99,9 +100,9 @@ <h2>Installation</h2>
<a href="#npm-commmands" id="npm-commmands" style="color: inherit; text-decoration: none;">
<h2>Npm Commmands</h2>
</a>
<p><code>npm run start</code> - start the development server using Snowpack - it&#39;s fast and run separatly from WordPress - use it for prototyping and quick testing</p>
<p><code>npm run start</code> - start the development server using Snowpack - it&#39;s fast and run separatly from WordPress - use it for development</p>
<p><code>npm run start-plugin</code> - start the development server in WordPress using Webpack - the project must be in <code>plugin</code> folder and activated - use it for testing the app as block in WordPress</p>
<p><code>npm run plugin-build</code> - created an optimased version for the app as a WordPress block</p>
<p><code>npm run plugin-build</code> - created an optimised version for the app as a WordPress block</p>
<p><code>npm run linux:make-zip</code> - this will start the <code>plugin-build</code> and pack it in a zip file in <code>./development</code> folder - use the zip to install the plugin on stagging site for testing - this will work on system that supports linux environment and command - <strong>must run <code>./delopment/linux_setup.sh</code> for installing the zip command</strong></p>
<p><code>npm run gen-docs</code> - generate the docs</p>
<p><code>npm run format</code> - format the Typescript file in <code>./src</code> folder using Prettier</p>
Expand Down
12 changes: 6 additions & 6 deletions docs/interfaces/engine_shapesaligner.basealigneroutput.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BaseAlignerOutput | undefined</title>
<meta name="description" content="Documentation for undefined">
<title>BaseAlignerOutput | logo-maker-plugin</title>
<meta name="description" content="Documentation for logo-maker-plugin">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
Expand All @@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">undefined</a>
<a href="../index.html" class="title">logo-maker-plugin</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">undefined</a>
<a href="../modules.html">logo-maker-plugin</a>
</li>
<li>
<a href="../modules/engine_shapesaligner.html">engine/shapesAligner</a>
Expand Down Expand Up @@ -106,7 +106,7 @@ <h3>container<wbr>Height</h3>
<div class="tsd-signature tsd-kind-icon">container<wbr>Height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/3461946/src/engine/shapesAligner.ts#L118">engine/shapesAligner.ts:118</a></li>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/2c60815/src/engine/shapesAligner.ts#L118">engine/shapesAligner.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -121,7 +121,7 @@ <h3>container<wbr>Width</h3>
<div class="tsd-signature tsd-kind-icon">container<wbr>Width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/3461946/src/engine/shapesAligner.ts#L116">engine/shapesAligner.ts:116</a></li>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/2c60815/src/engine/shapesAligner.ts#L116">engine/shapesAligner.ts:116</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
14 changes: 7 additions & 7 deletions docs/interfaces/engine_shapesaligner.baseshapedimensions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BaseShapeDimensions | undefined</title>
<meta name="description" content="Documentation for undefined">
<title>BaseShapeDimensions | logo-maker-plugin</title>
<meta name="description" content="Documentation for logo-maker-plugin">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
Expand All @@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">undefined</a>
<a href="../index.html" class="title">logo-maker-plugin</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">undefined</a>
<a href="../modules.html">logo-maker-plugin</a>
</li>
<li>
<a href="../modules/engine_shapesaligner.html">engine/shapesAligner</a>
Expand Down Expand Up @@ -107,7 +107,7 @@ <h3>logo<wbr>Dim</h3>
<div class="tsd-signature tsd-kind-icon">logo<wbr>Dim<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/3461946/src/engine/shapesAligner.ts#L17">engine/shapesAligner.ts:17</a></li>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/2c60815/src/engine/shapesAligner.ts#L17">engine/shapesAligner.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -133,7 +133,7 @@ <h3>slogan<wbr>Dim</h3>
<div class="tsd-signature tsd-kind-icon">slogan<wbr>Dim<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/3461946/src/engine/shapesAligner.ts#L27">engine/shapesAligner.ts:27</a></li>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/2c60815/src/engine/shapesAligner.ts#L27">engine/shapesAligner.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -159,7 +159,7 @@ <h3>title<wbr>Dim</h3>
<div class="tsd-signature tsd-kind-icon">title<wbr>Dim<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/3461946/src/engine/shapesAligner.ts#L22">engine/shapesAligner.ts:22</a></li>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/2c60815/src/engine/shapesAligner.ts#L22">engine/shapesAligner.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
32 changes: 24 additions & 8 deletions docs/interfaces/engine_shapesbuilder.baseshaphebuilder.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BaseShapheBuilder | undefined</title>
<meta name="description" content="Documentation for undefined">
<title>BaseShapheBuilder | logo-maker-plugin</title>
<meta name="description" content="Documentation for logo-maker-plugin">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
Expand All @@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">undefined</a>
<a href="../index.html" class="title">logo-maker-plugin</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">undefined</a>
<a href="../modules.html">logo-maker-plugin</a>
</li>
<li>
<a href="../modules/engine_shapesbuilder.html">engine/shapesBuilder</a>
Expand All @@ -73,14 +73,21 @@ <h1>Interface BaseShapheBuilder</h1>
<div class="lead">
<p>Base interface for creating/building shapes</p>
</div>
<p>Extend this inferface when adding functions to build more diverse shapes</p>
<p>Extend this inferface when adding essential shapes. Essential shapes are the shapes that appears on every logo.
If you want to make a customizer for the logo to add shapes like stars, circles, and they appaers only on some patters;
use <code>extendBaseShapes</code> function to add an extra property where you can store them, like &#39;extras&#39;.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">BaseShapheBuilder</span>
<ul class="tsd-hierarchy">
<li>
<a href="engine_shapesbuilder.extendedshapebuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">ExtendedShapeBuilder</a>
</li>
</ul>
</li>
</ul>
</section>
Expand All @@ -107,7 +114,7 @@ <h3>logo</h3>
<div class="tsd-signature tsd-kind-icon">logo<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Svg</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/3461946/src/engine/shapesBuilder.ts#L18">engine/shapesBuilder.ts:18</a></li>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/2c60815/src/engine/shapesBuilder.ts#L25">engine/shapesBuilder.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -122,7 +129,7 @@ <h3>slogan</h3>
<div class="tsd-signature tsd-kind-icon">slogan<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Text</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/3461946/src/engine/shapesBuilder.ts#L28">engine/shapesBuilder.ts:28</a></li>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/2c60815/src/engine/shapesBuilder.ts#L35">engine/shapesBuilder.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -137,7 +144,7 @@ <h3>title</h3>
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Text</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/3461946/src/engine/shapesBuilder.ts#L23">engine/shapesBuilder.ts:23</a></li>
<li>Defined in <a href="https://github.com/Codeinwp/logo-maker/blob/2c60815/src/engine/shapesBuilder.ts#L30">engine/shapesBuilder.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -242,9 +249,18 @@ <h3>title</h3>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="engine_shapesbuilder.extendedshapebuilder.html" class="tsd-kind-icon">Extended<wbr>Shape<wbr>Builder</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/engine_shapesbuilder.html#extrashape" class="tsd-kind-icon">Extra<wbr>Shape</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/engine_shapesbuilder.html#builddefaultshapes" class="tsd-kind-icon">build<wbr>Default<wbr>Shapes</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
<a href="../modules/engine_shapesbuilder.html#extendbaseshapes" class="tsd-kind-icon">extend<wbr>Base<wbr>Shapes</a>
</li>
</ul>
</nav>
</div>
Expand Down
Loading

0 comments on commit 3bd306e

Please sign in to comment.