xzdoc
Version:
Generate your documentation.
306 lines (237 loc) • 7.43 kB
HTML
<html>
<head>
<meta charset="utf-8" />
<title>xzdoc Documentation</title>
<meta name="keywords" content="documentation,dox" />
<meta name="description" content="Generate your documentation." />
<script src="assets/prettify.js"></script>
<script src="assets/jquery-1.8.2.min.js"></script>
<script src="assets/bootstrap/js/bootstrap.js"></script>
<link rel="stylesheet" type="text/css" href="assets/bootstrap/css/bootstrap.min.css" />
<link rel="stylesheet" type="text/css" href="assets/base.css" />
</head>
<body>
<nav class="navbar navbar-inverse navbar-static-top top-navbar" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<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="./index.html">xzdoc</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav">
<li>
<a href="./api.html">API Docs</a>
</li>
<li>
<a href="./Changelog.html">Changelog</a>
</li>
</ul>
</div><!-- /.navbar-collapse -->
</div>
</nav>
<header class="jumbotron subhead">
<div class="container">
<h1>xzdoc <small>Version: 0.0.4 By @Yggdrasill-7C9</small></h1>
<p class="lead">
Generate your documentation.
</p>
</div>
</header>
<div class="container content">
<div class="row">
<div class="col-md-3 bs-docs-sidebar">
<ul class="nav nav-list bs-docs-sidenav affix">
<li>
<div class="accordion" id="xzdoc">
<div class="accordion-group">
<div class="accordion-heading">
<a href="#api_xzdoc" class="api_side_link">xzdoc</a>
<div class="accordion-marker">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-parent="#xzdoc" href="#collapse_xzdoc">
<span class="glyphicon glyphicon-chevron-right"></span>
</a>
</div>
</div>
<div class="accordion-body collapse" id="collapse_xzdoc">
<div class="accordion-inner">
<ul class="indexs">
<li>
<a href="#xzdoc_exports_getIndexs">getIndexs</a>
</li>
<li>
<a href="#xzdoc_exports_version">version</a>
</li>
<li>
<a href="#xzdoc_exports_process">process</a>
</li>
<li>
<a href="#xzdoc_exports_list">list</a>
</li>
<li>
<a href="#xzdoc_exports_export">export</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</li>
</ul>
</div>
<div class="col-md-9">
<section id="api_xzdoc" class="api">
<h2>xzdoc: API索引</h2>
<ul class="indexs">
<li>
<a href="#xzdoc_exports_getIndexs">
getIndexs
</a>
</li>
<li>
<a href="#xzdoc_exports_version">
version
</a>
</li>
<li>
<a href="#xzdoc_exports_process">
process
</a>
</li>
<li>
<a href="#xzdoc_exports_list">
list
</a>
</li>
<li>
<a href="#xzdoc_exports_export">
export
</a>
</li>
</ul>
<hr />
<h3 data-id="xzdoc_exports_getIndexs">
getIndexs
</h3>
<p>从Markdown中提取标题列表</p>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>方法</td>
<td colspan="3">exports.getIndexs()</td>
</tr>
<tr>
<td>返回</td>
<td>Array</td>
<td colspan="2"><p>返回标题列表</p></td> </tr>
</table>
<h3 data-id="xzdoc_exports_version">
version
</h3>
<p>xzdoc的版本号</p>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>属性</td>
<td colspan="3">exports.version</td>
</tr>
</table>
<h3 data-id="xzdoc_exports_process">
process
</h3>
<p>处理目录，生成文档</p>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>方法</td>
<td colspan="3">exports.process()</td>
</tr>
<tr>
<td>参数</td>
<td>input(String)</td>
<td colspan="2"><p>输入目录路径</p></td>
</tr>
<tr>
<td>参数</td>
<td>output(String)</td>
<td colspan="2"><p>输出目录路径</p></td>
</tr>
</table>
<h3 data-id="xzdoc_exports_list">
list
</h3>
<p>显示所有主题列表</p>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>方法</td>
<td colspan="3">exports.list()</td>
</tr>
</table>
<h3 data-id="xzdoc_exports_export">
export
</h3>
<p>导出模板</p>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>方法</td>
<td colspan="3">exports.export()</td>
</tr>
</table>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>此文档通过xzdoc生成。主题借鉴Bootstrap API文档风格，注解基于<a href="https://github.com/visionmedia/dox">Dox</a>。欢迎关注xzdoc作者<a href="http://weibo.com/shyvo" target="_blank">@朴灵</a></p>
<ul class="footer-links">
<li><a href="https://github.com/visionmedia/dox">Dox主页</a></li>
<li><a href="http://html5ify.com/xzdoc">xzdoc主页</a></li>
<li><a href="https://github.com/Yggdrasill-7C9/xzdoc">xzdoc源码</a></li>
<li><a href="https://github.com/Yggdrasill-7C9/xzdoc/issues?state=open">提交bug</a></li>
</ul>
</div>
</footer>
<script>
$(function() {
$('pre').addClass('prettyprint');
$('td pre').removeClass('prettyprint');
prettyPrint();
var $window = $(window);
var sidenav = $('.bs-docs-sidenav');
if (sidenav.height() < window.innerHeight) {
sidenav.affix({
offset: {
top: function () {
return $window.width() <= 980 ? 290 : 210
},
bottom: 200
}
});
} else {
sidenav.removeClass('affix');
}
$(".content").find('h1, h2, h3, h4, h5, h6').each(function () {
var node = $(this);
// 总是设置id
node.attr("id", node.data('id') || "index_" + node.text());
});
$('.bs-docs-sidenav .accordion-marker').on('click', function(event) {
var current = $(event.currentTarget);
current.find('.glyphicon').toggleClass('glyphicon-chevron-right glyphicon-chevron-down');
});
});
</script>
</body>
</html>