perfectkb-yate
Version:
Yet Another Turtle Editor, forked from YASQE
64 lines (56 loc) • 3.22 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>YATE</title>
<link rel="icon" type="image/png" href="imgs/favicon.png">
<link href="doc.min.css" rel="stylesheet" type="text/css" />
<style>
</style>
</head>
<body data-spy="scroll" data-target="#sidebarmenu">
<a href="https://github.com/perfectkb/yate" target="_blank"><img style="z-index: 1; position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"></a>
<!-- Fixed navbar -->
<div class="navbar navbar-inverse" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../">YATE</a>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="../">About</a></li>
<li class="active"><a href="#l">Documentation</a></li>
<li><a target="_blank" href="http://yasqe.yasgui.org/">original YASQE</a></li>
<li><a target="_blank" href="http://laurensrietveld.nl">The author of YASGUI</a></li>
<li><a target="_blank" href="http://maxime-lefrancois.info/">The author of this fork</a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
</div>
<div class="container" role="main">
<div class="row">
<div class="col-md-9">
<h1>Documentation</h1>
YATE is a fork of the <a href="http://yasqe.yasgui.org/doc/" target="_blank">YASQE Library</a>.
Where YASQE provides <code>YASQE</code> in the global namespace, we provide <code>YATE</code>.
<h2 id="gettingStarted">Getting Started</h2>
<p>Initialize YATE via its constructor, or via the command <code>fromTextArea</code>. Both return in instance of YATE, from now on referred to as <code>yate</code> (lowercase). Both function take as argument a config object. See the section on <a href="#config">defaults</a> for more information on this config object.</p>
<div class="doc">
<code>YATE(parent: DOM-Element, settings: Object) → YATE instance: yate</code>
<p>Main YATE constructor. Pass a DOM element as argument to append the editor to, and (optionally) pass along config settings (see the YATE.defaults object below, as well as the regular CodeMirror documentation, for more information on configurability)</p>
</div>
<div class="doc">
<code>YATE.fromTextArea(textArea: DOM element, config: Object) → YATE instance: yate</code>
<p>Initialize YATE from an existing text area (see <a href="http://codemirror.net/doc/manual.html#fromTextArea" target="_blank">CodeMirror</a> for more info)</p>
</div>
<script src="doc.min.js"></script>
</body>
</html>