xzdoc
Version:
Generate your documentation.
258 lines (231 loc) • 7.84 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">
<ul class="nav nav-list bs-docs-sidenav affix">
<li class="level_1">
<a href="#index_Change log" title="Change log">
<i class="icon-chevron-right"></i>Change log
</a>
</li>
<li class="level_2">
<a href="#index_0.2.3" title="0.2.3">
<i class="icon-chevron-right"></i>0.2.3
</a>
</li>
<li class="level_2">
<a href="#index_0.2.0" title="0.2.0">
<i class="icon-chevron-right"></i>0.2.0
</a>
</li>
<li class="level_2">
<a href="#index_0.1.0" title="0.1.0">
<i class="icon-chevron-right"></i>0.1.0
</a>
</li>
<li class="level_2">
<a href="#index_0.0.12" title="0.0.12">
<i class="icon-chevron-right"></i>0.0.12
</a>
</li>
<li class="level_2">
<a href="#index_0.0.11" title="0.0.11">
<i class="icon-chevron-right"></i>0.0.11
</a>
</li>
<li class="level_2">
<a href="#index_0.0.10" title="0.0.10">
<i class="icon-chevron-right"></i>0.0.10
</a>
</li>
<li class="level_2">
<a href="#index_0.0.9" title="0.0.9">
<i class="icon-chevron-right"></i>0.0.9
</a>
</li>
<li class="level_2">
<a href="#index_0.0.8" title="0.0.8">
<i class="icon-chevron-right"></i>0.0.8
</a>
</li>
<li class="level_2">
<a href="#index_0.0.7" title="0.0.7">
<i class="icon-chevron-right"></i>0.0.7
</a>
</li>
<li class="level_2">
<a href="#index_0.0.6" title="0.0.6">
<i class="icon-chevron-right"></i>0.0.6
</a>
</li>
<li class="level_2">
<a href="#index_0.0.5" title="0.0.5">
<i class="icon-chevron-right"></i>0.0.5
</a>
</li>
<li class="level_2">
<a href="#index_0.0.4" title="0.0.4">
<i class="icon-chevron-right"></i>0.0.4
</a>
</li>
<li class="level_2">
<a href="#index_0.0.3" title="0.0.3">
<i class="icon-chevron-right"></i>0.0.3
</a>
</li>
</ul>
</div>
<div class="col-md-9">
<section>
<h1 id="change-log">Change log</h1>
<h2 id="0-2-3">0.2.3</h2>
<ul>
<li>2013-12-30：升级bootstrap到3.0.3。</li>
</ul>
<h2 id="0-2-0">0.2.0</h2>
<ul>
<li>2013-09-08：支持模板导出和基于自定义模板创建文档</li>
</ul>
<h2 id="0-1-0">0.1.0</h2>
<ul>
<li>2013-08-29：改进命令行的交互，不再支持node 0.6版本。</li>
</ul>
<h2 id="0-0-12">0.0.12</h2>
<ul>
<li>2013-01-30：通过在package.json中添加disqus，自动生成Disqus评论功能。</li>
</ul>
<h2 id="0-0-11">0.0.11</h2>
<ul>
<li>2012-11-05：支持node 0.6版本</li>
</ul>
<h2 id="0-0-10">0.0.10</h2>
<ul>
<li>2012-11-01：添加<code>-s</code>选项支持选择皮肤，目前提供<code>default</code>和<code>wordpress</code>两种皮肤</li>
</ul>
<h2 id="0-0-9">0.0.9</h2>
<ul>
<li>2012-11-01：Fix包文件中无keywords时的bug</li>
</ul>
<h2 id="0-0-8">0.0.8</h2>
<ul>
<li>2012-10-27：Use <code>marked</code> instead of <code>gfm</code></li>
</ul>
<h2 id="0-0-7">0.0.7</h2>
<ul>
<li>2012-10-17：当文档过多时，通过“更多”按钮来管理链接</li>
</ul>
<h2 id="0-0-6">0.0.6</h2>
<ul>
<li>2012-10-17：当没有<code>lib</code>目录时，不生成API Docs的链接</li>
</ul>
<h2 id="0-0-5">0.0.5</h2>
<ul>
<li>2012-10-15：在package.json中添加tracker配置<code>"tracker": "UA-17170593-4"</code>后，自动生成Google Tracker代码。注意，要获取tracker，需要<a href="http://www.google.com/analytics/">Google Analytics账户</a>，如<code>UA-17170593-4</code>。</li>
<li>2012-10-15：调整API文档的样式</li>
</ul>
<h2 id="0-0-4">0.0.4</h2>
<ul>
<li>2012-10-14：为每个Markdown文档生成索引</li>
<li>2012-10-14：添加测试</li>
</ul>
<h2 id="0-0-3">0.0.3</h2>
<ul>
<li>2012-10-14：采用<code>bootstrap</code>2.1.1，应用affix功能，使索引能够不随滚动而不见</li>
<li>2012-10-14：添加prettify，将文档中的代码进行美化</li>
<li>2012-10-14：左移品牌logo，去掉home链接，以显示更多的文档链接</li>
</ul>
</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>