| 1 | <!DOCTYPE html>
|
| 2 | <html lang="en">
|
| 3 | <head>
|
| 4 | <meta charset="UTF-8">
|
| 5 | <meta http-equiv="Content-Type" name="viewport" content="width=device-width, initial-scale=1"/>
|
| 6 | <title>Contributing</title>
|
| 7 | <link rel="stylesheet" href="https://leungwensen.github.io/zfinder/dist/lib/normalize-4.2.0.min.css">
|
| 8 |
|
| 9 | <link rel="stylesheet" href="https://leungwensen.github.io/zfinder/dist/lib/github-markdown-2.3.0.min.css">
|
| 10 | <link rel="stylesheet" href="https://leungwensen.github.io/zfinder/dist/zfinder/markdown-previewer.css">
|
| 11 | </head>
|
| 12 | <body>
|
| 13 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1"
|
| 14 | style="width:0;height:0;position:absolute;overflow:hidden;">
|
| 15 | <defs>
|
| 16 | <symbol id="si-zfinder-collapse-left" viewBox="0 0 38 38">
|
| 17 | <path d="M38 0H0v38h38V0zM3 35V3h32v32H3zM5 5v28h17V21h-9.667L16 26h-4l-5-7 5-7h4l-3.667 5H22V5H5z"/>
|
| 18 | </symbol>
|
| 19 | <symbol id="si-zfinder-expand-right" viewBox="0 0 38 38">
|
| 20 | <path d="M0 0h38v38H0V0zm35 35V3H3v32h32zM22 5v28H5V21h9.667L11 26h4l5-7-5-7h-4l3.667 5H5V5h17z"/>
|
| 21 | </symbol>
|
| 22 | <symbol id="si-zfinder-fullscreen" viewBox="0 0 28 28">
|
| 23 | <path d="M4 18H0v10h10v-4H4v-6zm-4-8h4V4h6V0H0v10zm24 14h-6v4h10V18h-4v6zM18 0v4h6v6h4V0H18z"/>
|
| 24 | </symbol>
|
| 25 | <symbol id="si-zfinder-fullscreen-exit" viewBox="0 0 28 28">
|
| 26 | <path d="M0 22h6v6h4V18H0v4zM6 6H0v4h10V0H6v6zm12 22h4v-6h6v-4H18v10zm4-22V0h-4v10h10V6h-6z"/>
|
| 27 | </symbol>
|
| 28 | </defs>
|
| 29 | </svg>
|
| 30 | <nav id="toc">
|
| 31 | <div id="toc-body" class="toc-body"></div>
|
| 32 | </nav>
|
| 33 | <article id="markdown">
|
| 34 | <nav id="markdown-header" class="markdown-header">
|
| 35 | <svg class="si" id="toggle-toc" width="24" height="24">
|
| 36 | <use xlink:href="#si-zfinder-collapse-left"></use>
|
| 37 | </svg>
|
| 38 | <svg class="si float-right" id="toggle-fullscreen-article" width="24" height="24">
|
| 39 | <use xlink:href="#si-zfinder-fullscreen"></use>
|
| 40 | </svg>
|
| 41 | </nav>
|
| 42 | <div id="markdown-body" class="markdown-body"><h1>Contributing</h1>
|
| 43 | <h2>Construction</h2>
|
| 44 | <h2>Scripts</h2>
|
| 45 | <h3>Dev Server</h3>
|
| 46 | <pre><code class="language-shell">$ gulp
|
| 47 | </code></pre>
|
| 48 | <p>Start a development server, pages below would be activated (file changes will trigger building automatically).</p>
|
| 49 | <ul>
|
| 50 | <li>Homepage: <a href="http://127.0.0.1:2047/">http://127.0.0.1:2047/</a></li>
|
| 51 | <li>Tests: <a href="http://127.0.0.1:2047/spec/">http://127.0.0.1:2047/spec/</a></li>
|
| 52 | </ul>
|
| 53 | <h3>Building(Packing)</h3>
|
| 54 | <pre><code class="language-shell">$ gulp pack
|
| 55 | </code></pre>
|
| 56 | <p>Packing, generates products into directory <code>/dist</code>.</p>
|
| 57 | <h3>Linting</h3>
|
| 58 | <pre><code class="language-shell">$ gulp lint
|
| 59 | # equals gulp eslint && gulp htmlhint
|
| 60 | </code></pre>
|
| 61 | <p>Linting.</p>
|
| 62 | <h3>Templates</h3>
|
| 63 | <pre><code class="language-shell">$ gulp template2module
|
| 64 | </code></pre>
|
| 65 | <p>Converting templates (<code>/src/template/*</code> and <code>/lib/template/*</code>) into js modules.</p>
|
| 66 | <h3>Others</h3>
|
| 67 | <ul>
|
| 68 | <li><code>$ gulp commonjs2es6</code> (be careful)</li>
|
| 69 | <li><code>$ gulp jsdoc</code></li>
|
| 70 | <li><code>$ gulp svg-sprite</code> (not ready yet)</li>
|
| 71 | </ul>
|
| 72 | </div>
|
| 73 | </article>
|
| 74 | <div id="loading">
|
| 75 | <div class="sk-double-bounce">
|
| 76 | <div class="sk-child sk-double-bounce1"></div>
|
| 77 | <div class="sk-child sk-double-bounce2"></div>
|
| 78 | </div>
|
| 79 | </div>
|
| 80 |
|
| 81 | <script src="https://leungwensen.github.io/zfinder/dist/lib/jquery-3.1.0.min.js"></script>
|
| 82 | <script src="https://leungwensen.github.io/zfinder/dist/lib/screenfull-3.0.0.min.js"></script>
|
| 83 | <script src="https://leungwensen.github.io/zfinder/dist/zfinder/markdown-previewer.js"></script>
|
| 84 | </body>
|
| 85 | </html>
|