mirror of
https://github.com/Hopiu/django-markdownx.git
synced 2026-05-02 10:34:44 +00:00
Updated/completed JavaScript docs.
This commit is contained in:
parent
ee38655cd5
commit
024a8d96b5
12 changed files with 45 additions and 20 deletions
|
|
@ -27,21 +27,25 @@ MarkdownX
|
|||
|
||||
:JSON Object: Keyboard events and their handlers.
|
||||
|
||||
.. js:attribute:: TAB
|
||||
.. js:data:: keys
|
||||
|
||||
- (*string*) - represents: ``Tab``
|
||||
:JSON Object: Custom hotkeys.
|
||||
|
||||
.. js:attribute:: DUPLICATE
|
||||
.. js:attribute:: TAB
|
||||
|
||||
- (*string*) - represents: ``d``
|
||||
- (*string*) - represents: ``Tab``
|
||||
|
||||
.. js:attribute:: UNINDENT
|
||||
.. js:attribute:: DUPLICATE
|
||||
|
||||
- (*string*) - represents: ``[``
|
||||
- (*string*) - represents: ``d``
|
||||
|
||||
.. js:attribute:: INDENT
|
||||
.. js:attribute:: UNINDENT
|
||||
|
||||
- (*string*) - represents: ``]``
|
||||
- (*string*) - represents: ``[``
|
||||
|
||||
.. js:attribute:: INDENT
|
||||
|
||||
- (*string*) - represents: ``]``
|
||||
|
||||
.. js:function:: hub(event)
|
||||
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ Utilities
|
|||
:param Boolean csrf: If ``true``, includes the CSRF token (under the name ``csrfmiddlewaretoken``) in the form.
|
||||
Default is ``true``.
|
||||
|
||||
:returns: A new instance **FormData** that incorporated the data embedded in ``data`` and the CSRF token in enabled.
|
||||
:returns: A new instance **FormData** that incorporated the data embedded in ``data`` and the CSRF token if enabled.
|
||||
:return type: FormData
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -27,21 +27,25 @@ MarkdownX
|
|||
|
||||
:JSON Object: Keyboard events and their handlers.
|
||||
|
||||
.. js:attribute:: TAB
|
||||
.. js:data:: keys
|
||||
|
||||
- (*string*) - represents: ``Tab``
|
||||
:JSON Object: Custom hotkeys.
|
||||
|
||||
.. js:attribute:: DUPLICATE
|
||||
.. js:attribute:: TAB
|
||||
|
||||
- (*string*) - represents: ``d``
|
||||
- (*string*) - represents: ``Tab``
|
||||
|
||||
.. js:attribute:: UNINDENT
|
||||
.. js:attribute:: DUPLICATE
|
||||
|
||||
- (*string*) - represents: ``[``
|
||||
- (*string*) - represents: ``d``
|
||||
|
||||
.. js:attribute:: INDENT
|
||||
.. js:attribute:: UNINDENT
|
||||
|
||||
- (*string*) - represents: ``]``
|
||||
- (*string*) - represents: ``[``
|
||||
|
||||
.. js:attribute:: INDENT
|
||||
|
||||
- (*string*) - represents: ``]``
|
||||
|
||||
.. js:function:: hub(event)
|
||||
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ Utilities
|
|||
:param Boolean csrf: If ``true``, includes the CSRF token (under the name ``csrfmiddlewaretoken``) in the form.
|
||||
Default is ``true``.
|
||||
|
||||
:returns: A new instance **FormData** that incorporated the data embedded in ``data`` and the CSRF token in enabled.
|
||||
:returns: A new instance **FormData** that incorporated the data embedded in ``data`` and the CSRF token if enabled.
|
||||
:return type: FormData
|
||||
|
||||
|
||||
|
|
|
|||
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -333,6 +333,10 @@
|
|||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="js/docs/markdownx.html#keyboardEvents">keyboardEvents (global variable or constant)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="js/docs/markdownx.html#keys">keys (global variable or constant)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
|
|
|||
|
|
@ -249,6 +249,17 @@ the defualt events are inhibited, and the drop event is set as <cite>copy</cite>
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="data">
|
||||
<dt id="keys">
|
||||
<code class="descname">keys</code><a class="headerlink" href="#keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">JSON Object:</th><td class="field-body">Custom hotkeys.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="attribute">
|
||||
<dt id="TAB">
|
||||
<code class="descname">TAB</code><a class="headerlink" href="#TAB" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -281,6 +292,8 @@ the defualt events are inhibited, and the drop event is set as <cite>copy</cite>
|
|||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="hub">
|
||||
<code class="descname">hub</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#hub" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
|
|||
|
|
@ -331,7 +331,7 @@ Default is <code class="docutils literal"><span class="pre">true</span></code>.<
|
|||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A new instance <strong>FormData</strong> that incorporated the data embedded in <code class="docutils literal"><span class="pre">data</span></code> and the CSRF token in enabled.</p>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A new instance <strong>FormData</strong> that incorporated the data embedded in <code class="docutils literal"><span class="pre">data</span></code> and the CSRF token if enabled.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">FormData</p>
|
||||
|
|
|
|||
BIN
docs/objects.inv
BIN
docs/objects.inv
Binary file not shown.
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue