Skip to content

Commit

Permalink
Update docs to cover urlProtocol and minimalLinks options
Browse files Browse the repository at this point in the history
  • Loading branch information
SDRACK committed Mar 15, 2018
1 parent 8463bff commit 1b35805
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions docs/documentation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ <h1 class="documentation-title">
<li><a href="#auto-grow">Auto grow</a></li>
<li><a href="#auto-grow-on-enter">Auto grow on enter</a></li>
<li><a href="#image-width-modal-edit">Image width modal edit</a></li>
<li><a href="#url-protocol">URL protocol</a></li>
<li><a href="#minimal-links">Minimal links</a></li>
</ul>
</li>
<li>
Expand Down Expand Up @@ -636,6 +638,59 @@ <h3 id="image-width-modal-edit">Image width modal edit</h3>
Image width modal edit is not active by default (set to <code>false</code>).
</p>
</div>


<div class="feature" data-added="2.9.4">
<h3 id="url-protocol">URL protocol</h3>
<p class="added-feature">Added in 2.9.4</p>
<p>
An option to auto-prefix URLs with a protocol.
</p>
<p>
When this option
is set to <code>true</code>, URLs missing a protocol will be
prefixed with <code>https://</code>. Alternatively, a string can
be provided for a custom prefix.
</p>
<p>
For example, a value of <code>true</code> would convert
<code>example.com</code> to
<code>https://example.com</code>, while a value of
<code>ftp</code> converts to
<code>ftp://example.com</code>.
</p>
<pre><code class="javascript">
$('.trumbowyg').trumbowyg({
urlProtocol: true
});
</code></pre>
<p class="note">
Anchors, email addresses and relative links are left unchanged.
</p>
<p class="note">
URL protocol is not active by default (set to <code>false</code>).
</p>
</div>


<div class="feature" data-added="2.9.4">
<h3 id="minimal-links">Minimal links</h3>
<p class="added-feature">Added in 2.9.4</p>
<p>
Reduce the link overlay to use only <code>url</code> and
<code>text</code> fields, omitting <code>title</code> and
<code>target</code>.
</p>
<pre><code class="javascript">
$('.trumbowyg').trumbowyg({
minimalLinks: true
});
</code></pre>
<p class="note">
The minimal links option is not active by default (set to
<code>false</code>).
</p>
</div>
</section>


Expand Down

0 comments on commit 1b35805

Please sign in to comment.