<!doctype html> | |
<html> | |
<head> | |
<meta charset='utf-8' /> | |
<title> | 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='w-100 sans-serif'> | |
<div class='pa3 ph4-ns bg-white'> | |
<div class='dt-ns w-100'> | |
<div class='db dtc-ns 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 dtc-ns v-mid w-100 tl tr-ns mt2 mt0-ns'> | |
<input type='text' placeholder='Search...' /> | |
</div> | |
</div> | |
</div> | |
<div class='bg-white black-70 bt b--black-10 flex-row flex-ns'> | |
<div class='navigation mw5-ns w-25-ns ph3 ph4-ns br-ns b--black-10 order-1-ns bg-near-white'> | |
<div class='ma0 pv3'> | |
<a href='#a' class='f5 fw4 dim link blue db pv1'>inlineTokenizer</a> | |
<a href='#b' class='f5 fw4 dim link blue db pv1'>renderMarkdown</a> | |
<a href='#b' class='f5 fw4 dim link blue db pv1'>typesandnonbreakinglongname</a> | |
</div> | |
</div> | |
<div class='order-2-ns flex-auto-0 black-70'> | |
<div class='pa4-ns pa3'> | |
<h3 class='f3' id='inline_tokenizer'> | |
inline_tokenizer | |
</h3> | |
<div class='code pa3 ba b--black-10'>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 class='lh-copy'> | |
<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='f4'>Parameters</h4> | |
<div class='prose'> | |
<div class='space-bottom0'> | |
<div> | |
<span class='code bold'>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> | |
</div> | |
</div> | |
<h4 class='f4'>Returns</h4> | |
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>: | |
</div> | |
</div> | |
</div> | |
</body> | |
</html> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment