Skip to content

Commit 2905ab6

Browse files
tigitztigitz
committed
docs: support feather v2, generate from any cwd
1 parent 74432f4 commit 2905ab6

23 files changed

+210
-209
lines changed

‎docs/docs/contributing/tests.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ <h2 class="h6 text-uppercase menu-head-item">Contributing</h2>
133133
<a href="../../index.html" class="brand">PHP-Spellchecker</a>
134134
</div>
135135
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarTogglerDemo02" aria-controls="navbarTogglerDemo02" aria-expanded="false" aria-label="Toggle navigation">
136-
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu icon" style="fill: true" ><line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line></svg>
136+
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu icon" style="fill: true" aria-hidden="true"><line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line></svg>
137137
</button>
138138
</div>
139139
<div class="collapse navbar-collapse" id="navbarTogglerDemo02">
@@ -226,8 +226,8 @@ <h2 class="menu-head-item h5 nav-link text-uppercase">Contributing</h2>
226226
</ul>
227227

228228
<form class="form-inline d-flex justify-content-around my-2 my-lg-0">
229-
<a class="btn btn-outline-primary mr-3" href="https://github.com/tigitz/php-spellchecker">Like it? Star us!<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-star icon ml-2 gh-star" style="fill: true" ><polygon points="12 2 15.09 8.26 22 9.27 17 14.14 18.18 21.02 12 17.77 5.82 21.02 7 14.14 2 9.27 8.91 8.26 12 2"></polygon></svg></a></button>
230-
<a class="btn btn-outline-primary" href="https://gitter.im/php-spellchecker/community" class="chat-gitter">Help<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-message-square icon ml-2 gh-star" style="fill: true" ><path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z"></path></svg></a>
229+
<a class="btn btn-outline-primary mr-3" href="https://github.com/tigitz/php-spellchecker">Like it? Star us!<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-star icon ml-2 gh-star" style="fill: true" aria-hidden="true"><polygon points="12 2 15.09 8.26 22 9.27 17 14.14 18.18 21.02 12 17.77 5.82 21.02 7 14.14 2 9.27 8.91 8.26 12 2"></polygon></svg></a></button>
230+
<a class="btn btn-outline-primary" href="https://gitter.im/php-spellchecker/community" class="chat-gitter">Help<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-message-square icon ml-2 gh-star" style="fill: true" aria-hidden="true"><path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z"></path></svg></a>
231231
</form>
232232
</div>
233233
</nav>
@@ -236,7 +236,7 @@ <h2 class="menu-head-item h5 nav-link text-uppercase">Contributing</h2>
236236
<form class="form-inline mt-2 mt-md-0">
237237
<div class="input-group">
238238
<div class="input-group-prepend">
239-
<div class="input-group-text"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search" ><circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line></svg></div>
239+
<div class="input-group-text"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search" aria-hidden="true"><circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line></svg></div>
240240
</div>
241241
<input disabled class="form-control mr-sm-2 search-input" type="text" placeholder="Search coming soon"
242242
aria-label="Search">
@@ -245,10 +245,10 @@ <h2 class="menu-head-item h5 nav-link text-uppercase">Contributing</h2>
245245
<div id="navbarSupportedContent">
246246
<ul class="navbar-nav ml-auto mt-2 mt-lg-0">
247247
<li class="nav-item mr-4">
248-
<a href="https://github.com/tigitz/php-spellchecker">Like it? Star us!<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-star icon ml-2 gh-star" style="fill: true" ><polygon points="12 2 15.09 8.26 22 9.27 17 14.14 18.18 21.02 12 17.77 5.82 21.02 7 14.14 2 9.27 8.91 8.26 12 2"></polygon></svg></a>
248+
<a href="https://github.com/tigitz/php-spellchecker">Like it? Star us!<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-star icon ml-2 gh-star" style="fill: true" aria-hidden="true"><polygon points="12 2 15.09 8.26 22 9.27 17 14.14 18.18 21.02 12 17.77 5.82 21.02 7 14.14 2 9.27 8.91 8.26 12 2"></polygon></svg></a>
249249
</li>
250250
<li class="nav-item mr-4">
251-
<a href="https://gitter.im/php-spellchecker/community" class="chat-gitter">Help<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-message-square icon ml-2 gh-star" style="fill: true" ><path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z"></path></svg></a>
251+
<a href="https://gitter.im/php-spellchecker/community" class="chat-gitter">Help<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-message-square icon ml-2 gh-star" style="fill: true" aria-hidden="true"><path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z"></path></svg></a>
252252
</li>
253253
</ul>
254254
</div>
@@ -257,8 +257,8 @@ <h2 class="menu-head-item h5 nav-link text-uppercase">Contributing</h2>
257257

258258
<div class="container ml-md-3 px-md-5 pt-md-5 position-relative">
259259
<div class="d-none d-sm-block position-absolute float-right" style="margin-top: 2.8rem ;right: 3rem;">
260-
<a href="https://github.com/tigitz/php-spellchecker/edit/master/docs/content%2F07_Contributing%2F01_Tests.md"
261-
class="btn btn-outline-primary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github icon mr-1" ><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"></path></svg> edit on
260+
<a href="https://github.com/tigitz/php-spellchecker/edit/master/docs/%2Fhome%2Fpsegatori%2Fwww%2Fphp-spellchecker%2Fdocs%2Fcontent%2F07_Contributing%2F01_Tests.md"
261+
class="btn btn-outline-primary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github icon mr-1" aria-hidden="true"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"></path></svg> edit on
262262
GitHub</a>
263263
</div>
264264
<br>
@@ -268,11 +268,11 @@ <h1>Testing</h1>
268268
<p>The most convenient way to do it is by using Docker and avoid polluting your local machine.</p>
269269
<h2>Docker</h2>
270270
<p>Requires <code>docker</code> and <code>docker-compose</code> to be installed (tested on Linux).</p>
271-
<pre><code class="language-sh">$ make build # build container images
272-
$ make setup # start spellcheckers container
273-
$ make tests-dox</code></pre>
271+
<pre><code class="language-sh">make build # build container images
272+
make setup # start spellcheckers container
273+
make tests-dox</code></pre>
274274
<p>You can also specify PHP version, dependency version target and if you want coverage. Coverage is only supported by PHP 7.2 for now.</p>
275-
<pre><code class="language-sh">$ PHP_VERSION=7.2 DEPS=LOWEST WITH_COVERAGE="true" make tests-dox</code></pre>
275+
<pre><code class="language-sh">PHP_VERSION=7.2 DEPS=LOWEST WITH_COVERAGE="true" make tests-dox</code></pre>
276276
<p>Run <code>make help</code> to list all available tasks.</p>
277277
<h2>Locally</h2>
278278
<p>Todo</p>

‎docs/docs/getting-started/architecture.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ <h2 class="h6 text-uppercase menu-head-item">Contributing</h2>
133133
<a href="../../index.html" class="brand">PHP-Spellchecker</a>
134134
</div>
135135
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarTogglerDemo02" aria-controls="navbarTogglerDemo02" aria-expanded="false" aria-label="Toggle navigation">
136-
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu icon" style="fill: true" ><line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line></svg>
136+
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu icon" style="fill: true" aria-hidden="true"><line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line></svg>
137137
</button>
138138
</div>
139139
<div class="collapse navbar-collapse" id="navbarTogglerDemo02">
@@ -226,8 +226,8 @@ <h2 class="menu-head-item h5 nav-link text-uppercase">Contributing</h2>
226226
</ul>
227227

228228
<form class="form-inline d-flex justify-content-around my-2 my-lg-0">
229-
<a class="btn btn-outline-primary mr-3" href="https://github.com/tigitz/php-spellchecker">Like it? Star us!<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-star icon ml-2 gh-star" style="fill: true" ><polygon points="12 2 15.09 8.26 22 9.27 17 14.14 18.18 21.02 12 17.77 5.82 21.02 7 14.14 2 9.27 8.91 8.26 12 2"></polygon></svg></a></button>
230-
<a class="btn btn-outline-primary" href="https://gitter.im/php-spellchecker/community" class="chat-gitter">Help<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-message-square icon ml-2 gh-star" style="fill: true" ><path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z"></path></svg></a>
229+
<a class="btn btn-outline-primary mr-3" href="https://github.com/tigitz/php-spellchecker">Like it? Star us!<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-star icon ml-2 gh-star" style="fill: true" aria-hidden="true"><polygon points="12 2 15.09 8.26 22 9.27 17 14.14 18.18 21.02 12 17.77 5.82 21.02 7 14.14 2 9.27 8.91 8.26 12 2"></polygon></svg></a></button>
230+
<a class="btn btn-outline-primary" href="https://gitter.im/php-spellchecker/community" class="chat-gitter">Help<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-message-square icon ml-2 gh-star" style="fill: true" aria-hidden="true"><path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z"></path></svg></a>
231231
</form>
232232
</div>
233233
</nav>
@@ -236,7 +236,7 @@ <h2 class="menu-head-item h5 nav-link text-uppercase">Contributing</h2>
236236
<form class="form-inline mt-2 mt-md-0">
237237
<div class="input-group">
238238
<div class="input-group-prepend">
239-
<div class="input-group-text"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search" ><circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line></svg></div>
239+
<div class="input-group-text"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search" aria-hidden="true"><circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line></svg></div>
240240
</div>
241241
<input disabled class="form-control mr-sm-2 search-input" type="text" placeholder="Search coming soon"
242242
aria-label="Search">
@@ -245,10 +245,10 @@ <h2 class="menu-head-item h5 nav-link text-uppercase">Contributing</h2>
245245
<div id="navbarSupportedContent">
246246
<ul class="navbar-nav ml-auto mt-2 mt-lg-0">
247247
<li class="nav-item mr-4">
248-
<a href="https://github.com/tigitz/php-spellchecker">Like it? Star us!<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-star icon ml-2 gh-star" style="fill: true" ><polygon points="12 2 15.09 8.26 22 9.27 17 14.14 18.18 21.02 12 17.77 5.82 21.02 7 14.14 2 9.27 8.91 8.26 12 2"></polygon></svg></a>
248+
<a href="https://github.com/tigitz/php-spellchecker">Like it? Star us!<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-star icon ml-2 gh-star" style="fill: true" aria-hidden="true"><polygon points="12 2 15.09 8.26 22 9.27 17 14.14 18.18 21.02 12 17.77 5.82 21.02 7 14.14 2 9.27 8.91 8.26 12 2"></polygon></svg></a>
249249
</li>
250250
<li class="nav-item mr-4">
251-
<a href="https://gitter.im/php-spellchecker/community" class="chat-gitter">Help<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-message-square icon ml-2 gh-star" style="fill: true" ><path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z"></path></svg></a>
251+
<a href="https://gitter.im/php-spellchecker/community" class="chat-gitter">Help<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-message-square icon ml-2 gh-star" style="fill: true" aria-hidden="true"><path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z"></path></svg></a>
252252
</li>
253253
</ul>
254254
</div>
@@ -257,8 +257,8 @@ <h2 class="menu-head-item h5 nav-link text-uppercase">Contributing</h2>
257257

258258
<div class="container ml-md-3 px-md-5 pt-md-5 position-relative">
259259
<div class="d-none d-sm-block position-absolute float-right" style="margin-top: 2.8rem ;right: 3rem;">
260-
<a href="https://github.com/tigitz/php-spellchecker/edit/master/docs/content%2F01_Getting_Started%2F03_Architecture.md"
261-
class="btn btn-outline-primary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github icon mr-1" ><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"></path></svg> edit on
260+
<a href="https://github.com/tigitz/php-spellchecker/edit/master/docs/%2Fhome%2Fpsegatori%2Fwww%2Fphp-spellchecker%2Fdocs%2Fcontent%2F01_Getting_Started%2F03_Architecture.md"
261+
class="btn btn-outline-primary"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github icon mr-1" aria-hidden="true"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"></path></svg> edit on
262262
GitHub</a>
263263
</div>
264264
<br>

0 commit comments

Comments
 (0)