|
| 1 | +<br/> |
| 2 | +<br/> |
| 3 | + |
| 4 | +<p align="center"> |
| 5 | + <img src="https://os-expected.github.io/EzGitDoc-documentation/img/favicon.png" alt="EzGitDoc logo" height="200"/> <br/><br/> |
| 6 | + Can <strong>project documentation be fun to do</strong> and then interesting to read by it's users? <br/> EzGitDoc is <strong>WYSIWYG "clicking" tool</strong> designed to improve Git repositories documentation experience. <br/><br/> <h3 align="center">Check it by yourself :)</h3> |
| 7 | +</p> |
| 8 | + |
| 9 | +<br/> |
| 10 | +<br/> |
| 11 | + |
| 12 | +<pre> |
| 13 | + <h3>1. Personalize look and functionality. </h3> |
| 14 | +</pre> |
| 15 | + |
1 | 16 | <p align="center">
|
2 |
| - <a href="https://os-expected.github.io/EzGitDoc-documentation/"><kbd><img src="https://raw.githubusercontent.com/trolit/EzGitDoc/master/images/readme/documentation.png" height="240" alt="docs image"/></kbd></a> |
3 |
| - <a href="https://os-expected.github.io/EzGitDoc/"><kbd><img src="https://raw.githubusercontent.com/trolit/EzGitDoc/master/images/readme/tool.png" height="240" alt="tool image"/></kbd></a> |
| 17 | + <img src="https://raw.githubusercontent.com/OS-expected/EzGitDoc/master/images/readme/2021/photo1.png" alt="EzGitDoc photo 1" height="450"/> |
| 18 | + <img src="https://raw.githubusercontent.com/OS-expected/EzGitDoc/master/images/readme/2021/photo2.png" alt="EzGitDoc photo 2" height="350"/> |
4 | 19 | </p>
|
5 | 20 |
|
6 |
| -## About |
| 21 | +<pre> |
| 22 | + <h3>2. Quickly redesign template... </h3> |
| 23 | +</pre> |
7 | 24 |
|
8 |
| -<p align="justify"> |
9 |
| -Open-source, WYSIWYG tool designed to improve Git repositories documentation experience. Click on the images above to be redirected onto docs/tool page. Thanks to <a href="https://github.com/damianggg">@damianggg</a> for spending time on functional tests 👍 |
| 25 | +<p align="center"> |
| 26 | + <img src="https://raw.githubusercontent.com/OS-expected/EzGitDoc/master/images/readme/2021/photo3.gif" alt="EzGitDoc photo 3" height="250"/> |
10 | 27 | </p>
|
11 | 28 |
|
12 |
| -## Preview |
| 29 | +<pre> |
| 30 | + <h4>...and when your template gets more complicated, quickly rearrange or move elements via references section. </h4> |
| 31 | +</pre> |
13 | 32 |
|
14 | 33 | <p align="center">
|
15 |
| -<kbd><img src="https://raw.githubusercontent.com/trolit/EzGitDoc/master/images/readme/gallery/fancy1.PNG" alt="Preview 1" width="300" height="136"/></kbd> |
16 |
| -<kbd><img src="https://raw.githubusercontent.com/trolit/EzGitDoc/master/images/readme/gallery/fancy2.PNG" alt="Preview 2" width="300" height="136"/></kbd> |
17 |
| -<br/> |
18 |
| -<kbd><img src="https://raw.githubusercontent.com/trolit/EzGitDoc/master/images/readme/gallery/fancy3.PNG" alt="Preview 3" width="300" height="136"/></kbd> |
19 |
| -<kbd><img src="https://raw.githubusercontent.com/trolit/EzGitDoc/master/images/readme/gallery/fancy4.PNG" alt="Preview 4" width="300" height="136"/></kbd> |
| 34 | + <img src="https://raw.githubusercontent.com/OS-expected/EzGitDoc/master/images/readme/2021/photo4.gif" alt="EzGitDoc photo 4" height="250"/> |
20 | 35 | </p>
|
21 | 36 |
|
| 37 | +<pre> |
| 38 | + <h3>3. Preview your work at EzGitDoc. </h3> |
| 39 | +</pre> |
| 40 | + |
| 41 | +<p align="center"> |
| 42 | + <img src="https://raw.githubusercontent.com/OS-expected/EzGitDoc/master/images/readme/2021/photo5.png" alt="EzGitDoc photo 5" height="250"/> |
| 43 | +</p> |
| 44 | + |
| 45 | +<pre> |
| 46 | + <h3>4. Generate code and put it onto your readme making final touches. </h3> |
| 47 | +</pre> |
| 48 | + |
| 49 | +<p align="center"> |
| 50 | + <img src="https://raw.githubusercontent.com/OS-expected/EzGitDoc/master/images/readme/2021/photo6.gif" alt="EzGitDoc photo 6" height="500"/> |
| 51 | +</p> |
| 52 | + |
| 53 | +<pre> |
| 54 | + <h3>5. Achieve attention. </h3> |
| 55 | +</pre> |
| 56 | + |
| 57 | +<h2 align="center">Project details</h2> |
| 58 | +<br/> |
| 59 | +EzGitDoc documentation(including quick guide) can be found at: <br/> |
| 60 | +https://os-expected.github.io/EzGitDoc-documentation/ |
| 61 | +<br/><br/> |
| 62 | +while the tool is available at: <br/> |
| 63 | +https://os-expected.github.io/EzGitDoc/. |
| 64 | + |
| 65 | +<br/> |
| 66 | +<br/> |
| 67 | + |
22 | 68 | ---
|
23 | 69 |
|
24 |
| -Icon responding for EzGitDoc logo belongs to Font Awesome and is available <a href="https://fontawesome.com/icons/earlybirds">over here</a>. |
| 70 | +Thanks to <a href="https://github.com/damianggg">@damianggg</a> for spending time on functional tests 👍 |
| 71 | + |
| 72 | +Icon responding for EzGitDoc logo belongs to Font Awesome and is available <a href="https://fontawesome.com/icons/earlybirds">over here</a> |
25 | 73 |
|
26 | 74 | Loading image source: <a href="https://loading.io/spinner/">Loading.io</a>
|
0 commit comments