Skip to content

Instantly share code, notes, and snippets.

@tmcw

tmcw/index.html

Created December 25, 2016 15:16
Show Gist options
  • Save tmcw/b013e94ae01ae2fca51018f4d0719589 to your computer and use it in GitHub Desktop.
Save tmcw/b013e94ae01ae2fca51018f4d0719589 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
index.html
<!doctype html>
<html>
<head>
<meta charset='utf-8' />
<title>tokenizer.js documentation</title>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/tachyons.min.css' type='text/css' rel='stylesheet' />
<link href='assets/github.css' type='text/css' rel='stylesheet' />
<style>
.navigation {
order: 2; }
@media (min-width: 768px) {
.navigation {
overflow: hidden;
word-wrap: normal;
}
}
.flex-auto-0 {
flex: 1 1 0%;
}
</style>
</head>
<body class='sans-serif'>
<div class='mw8 '>
<div class='pa3 bg-white bn-ns bb b--black-20'>
<div class='dt-ns w-100'>
<div class='db dtc v-mid tl w-50'>
<a class='dib f4'>
tokenizer.js
<div class='dib'>
<span class='f6 black-70 nowrap'>v1.0.0</span>
</div>
</a>
</div>
<div class='db-ns dn dtc-ns v-mid w-100 tl tr-ns mt2 mt0-ns'>
<input type='text' class='pa1 ba b--black-20' placeholder='Search...' />
</div>
<div class='dn-ns dtc v-mid w-10 tl tr mt2 mt0-ns'>
<a class='bg-near-white pa2 br4 black-50 no-underline' href='#'>
Menu
</a>
</div>
</div>
</div>
</div>
<div class='black-70 bt-m bt-l b--black-20 bg-white'>
<div class='mw8 black-70 flex-row flex-ns'>
<div class='navigation dn db-ns mw5-ns w-25-ns order-1-ns pa3'>
<div class='ma0 pt3'>
Geography
</div>
<div class='ma0 pv1'>
<a href='#a' class='f5 fw4 dim link blue truncate db pv1'>inlineTokenizer</a>
<a href='#b' class='f5 fw4 dim link blue truncate db pv1'>renderMarkdown</a>
<a href='#b' class='f5 fw4 dim link blue truncate db pv1'>typesandnonbreakinglongname</a>
</div>
<div class='ma0 pt3'>
Basic Types
</div>
<div class='ma0 pv1'>
<a href='#a' class='f5 fw4 dim link blue truncate db pv1'>LatLng</a>
<a href='#b' class='f5 fw4 dim link blue truncate db pv1'>Rect</a>
</div>
<div class='ma0 pt3'>
Utilities
</div>
<div class='ma0 pv1'>
<a href='#a' class='f5 fw4 dim link blue truncate db pv1'>bitToMegabit</a>
<a href='#b' class='f5 fw4 dim link blue truncate db pv1'>breakfastNow</a>
</div>
</div>
<div class='order-2-ns flex-auto-0 black-70 bg-white'>
<div class='pa4-ns pa3'>
<h3 class='f3 mt0' id='inline_tokenizer'>
inline_tokenizer
</h3>
<div>
<div class='dib code pa3 ba br2 b--black-20'>inline_tokenizer(processor: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>
</div>
<div class='lh-copy f5 measure-wide'>
<p>A remark plugin that installs
<a href="https://github.com/wooorm/remark/blob/master/doc/remarkplugin.3.md#function-tokenizereat-value-silent">tokenizers</a>
and <a href="https://github.com/wooorm/remark/blob/master/doc/remarkplugin.3.md#function-locatorvalue-fromindex">locators</a>
for JSDoc inline <code>{@link}</code> and <code>{@tutorial}</code> tags.</p>
<p>This does not handle the <code>[text]({@link url})</code> and <code>[text]({@tutorial url})</code> forms of these tags.
That's a JSDoc misfeature; just use regular markdown syntax instead: <code>[text](url)</code>.</p>
</div>
<h4 class='f5'>Example</h4>
<pre class='pa2 bg-near-white'><span class="hljs-keyword">var</span> tooltip = <span class="hljs-keyword">new</span> mapboxgl.Popup()
.setLatLng(map.unproject(e.point))
.setHTML(<span class="hljs-string">"&lt;h1&gt;Hello World!&lt;/h1&gt;"</span>)
.addTo(map);</pre>
<h4 class='f5'>Parameters</h4>
<div class='prose'>
<span>processor</span> <code class='quiet'>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</code> remark instance
</div>
<h4 class='f5'>Returns</h4>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>:
</div>
</div>
</div>
</div>
<div class='bt b--black-20'>
<div class='mw8 '>
<div class='pa3 bg-white'>
<div class='f6 black-70 lh-copy'>
<div>
&copy; 2016 BigCorp
</div>
<div>
Generated by <a class='blue dim link' href='http://documentation.js.org'>documentation.js v4.0.0</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment