Added documentation

This commit is contained in:
Alexey Gulev
2019-09-24 13:24:45 +02:00
parent 2c23e2f45a
commit edf4e920df
39 changed files with 2817 additions and 3 deletions

View File

@@ -0,0 +1,38 @@
{% assign truncate = 10000 %}
{% if include.truncate %}
{% assign truncate = include.truncate %}
{% endif %}
{{ include.desc
| truncate: truncate
| replace: "[type:string]","<code class='inline-code-block'>string</code>"
| replace: "[type:number]","<code class='inline-code-block'>number</code>"
| replace: "[type:table]","<code class='inline-code-block'>table</code>"
| replace: "[icon:attention]","<br><br><span class='icon-attention'></span>"
| replace: "[icon:android]", "<span class='icon-android'></span>"
| replace: "[icon:gameroom]", "<span class='icon-gameroom'></span>"
| replace: "[icon:apple]", "<span class='icon-apple'></span>"
| replace: "[icon:clipboard]", "<span class='icon-clipboard'></span>"
| replace: "[icon:king]", "<span class='icon-king'></span>"
| replace: "[icon:defold]", "<span class='icon-defold'></span>"
| replace: "[icon:search]", "<span class='icon-search'></span>"
| replace: "[icon:link-ext]", "<span class='icon-link-ext'></span>"
| replace: "[icon:link]", "<span class='icon-link'></span>"
| replace: "[icon:amazon]", "<span class='icon-amazon'></span>"
| replace: "[icon:html5]", "<span class='icon-html5'></span>"
| replace: "[icon:ios]", "<span class='icon-ios'></span>"
| replace: "[icon:linux]", "<span class='icon-linux'></span>"
| replace: "[icon:windows]", "<span class='icon-windows'></span>"
| replace: "[icon:macos]", "<span class='icon-macos'></span>"
| replace: "[icon:clock]", "<span class='icon-clock'></span>"
| replace: "[icon:star]", "<span class='icon-star'></span>"
| replace: "[icon:googleplay]", "<span class='icon-googleplay'></span>"
| replace: "[icon:dropbox]", "<span class='icon-dropbox'></span>"
| replace: "[icon:twitter]", "<span class='icon-twitter'></span>"
| replace: "[icon:slack]", "<span class='icon-slack'></span>"
| replace: "[icon:instagram]", "<span class='icon-instagram'></span>"
| replace: "[icon:steam]", "<span class='icon-steam'></span>"
| replace: "[icon:github]", "<span class='icon-github'></span>"
| replace: "[icon:facebook]", "<span class='icon-facebook'></span>"
| markdownify
}}

View File

@@ -0,0 +1,23 @@
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{% for param in include.params %}
<tr>
<td><strong>{{ param.name }}</strong></td>
<td><code>{{ param.type }}</code></td>
<td>{% include description.md desc=param.desc %}
{% if param.type == "table" %}
{% include type-table.md fields=param.members %}
{% endif %}
</td>
</tr>
{% endfor %}
</tbody>
</table>

View File

@@ -0,0 +1,11 @@
<ul>
{% for field in include.fields %}
<li>
<strong>{{ field.name }}</strong>
{% if field.optional %}
(optional)
{% endif %}
<code>{{ field.type }}</code> - {% include description.md desc=field.desc %}
</li>
{% endfor %}
</ul>