Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

add language support for en_US for default template #38

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ Doxmate将会扫描项目下的README.md和doc目录下的md文件,通过markd

```

## International version
[See en_US branch](https://github.com/cbou/markdox/tree/en_US)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link is 404


## License (MIT)
MIT许可,请自由享用。

Expand Down
22 changes: 11 additions & 11 deletions lib/doxmate.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,17 @@ var getTemplates = function (skin, input) {
};

var types = {
"param": "参数",
"examples": "示例",
"return": "返回",
"method": "方法",
"api": "可见度",
"property": "属性",
"function": "函数",
"declaration": "声明",
"exception": "异常",
"callmethod": "调用方式",
"name": "名字"
"param": "Parameter",
"examples": "Example",
"return": "Returns",
"method": "Method",
"api": "Visibility",
"property": "Attributes",
"function": "Function",
"declaration": "Declaration",
"exception": "Exception",
"callmethod": "Calling Method",
"name": "Name"
};

var getName = function (comment) {
Expand Down
7 changes: 2 additions & 5 deletions templates/default/footer.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,9 @@
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>此文档通过doxmate生成。主题借鉴Bootstrap API文档风格,注解基于<a href="https://github.com/visionmedia/dox">Dox</a>。欢迎关注doxmate作者<a href="http://weibo.com/shyvo" target="_blank">@朴灵</a></p>
<p>Made by <a href="https://github.com/<%= author %>"><%= author %></a></p>
<ul class="footer-links">
<li><a href="https://github.com/visionmedia/dox">Dox主页</a></li>
<li><a href="http://html5ify.com/doxmate">Doxmate主页</a></li>
<li><a href="https://github.com/JacksonTian/doxmate">Doxmate源码</a></li>
<li><a href="https://github.com/JacksonTian/doxmate/issues?state=open">提交bug</a></li>
<li>Fork me on <a href="repository.url">GitHub</a></li>
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the url may not be rendered.

</ul>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion templates/default/header.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
</nav>
<header class="jumbotron subhead">
<div class="container">
<h1><%= name %> <small>Version: <%= version %> By @<%= author %></small></h1>
<h1><%= name %> <small>Version: <%= version %></small></h1>
<p class="lead">
<%= description %>
</p>
Expand Down
4 changes: 2 additions & 2 deletions templates/default/section.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<section id="api_<%=basename%>" class="api">
<h2><%=basename%>: API索引</h2>
<h2><%=basename%> API Docs</h2>
<ul class="indexs">
<%
var indexs = comments.filter(function (item) {
Expand Down Expand Up @@ -27,7 +27,7 @@ <h3 data-id="<%= basename + '_' + comment.ctx.receiver + '_' + __getName(comment
<% if (comment.code) { %>
<%-comment.description.full%>
<% } %>
<p>方法签名</p>
<p>Method Signatures</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<% if (comment.ctx) { %>
<tr>
Expand Down