mathjax-yard 1.0.2 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.#Rakefile +1 -0
- data/.yardopts +1 -3
- data/README.md +70 -37
- data/Rakefile +8 -9
- data/doc/MathJaxYard.html +47 -47
- data/doc/MathJaxYard/Command.html +289 -182
- data/doc/Mathjax-yard_design_20160624.png +0 -0
- data/doc/_index.html +38 -33
- data/doc/class_list.html +24 -31
- data/doc/css/full_list.css +32 -31
- data/doc/css/style.css +220 -78
- data/doc/file.CODE_OF_CONDUCT.html +132 -0
- data/doc/file.Home.html +119 -66
- data/doc/file.README.html +119 -66
- data/doc/file.README_ja.html +119 -66
- data/doc/file.Why_mathjax-yard.html +29 -30
- data/doc/file.Why_mathjax-yard.mjx.html +29 -30
- data/doc/file.atom.html +30 -31
- data/doc/file.atom.mjx.html +30 -31
- data/doc/file.left_issue.html +111 -0
- data/doc/file.potential.html +29 -30
- data/doc/file.potential.mjx.html +29 -30
- data/doc/file_list.html +60 -38
- data/doc/frames.html +7 -16
- data/doc/index.html +119 -66
- data/doc/js/app.js +100 -76
- data/doc/js/full_list.js +170 -135
- data/doc/method_list.html +96 -68
- data/doc/top-level-namespace.html +48 -50
- data/hikis/Mathjax-yard_design_20160624.pdf +0 -0
- data/hikis/Mathjax-yard_design_20160624.png +0 -0
- data/{docs → hikis}/README_ja.hiki +68 -37
- data/{docs → hikis}/Why_mathjax-yard.hiki +0 -0
- data/{docs → hikis}/atom.hiki +1 -1
- data/hikis/left_issue.hiki +19 -0
- data/{docs → hikis}/potential.hiki +0 -0
- data/lib/mathjax-yard.rb +26 -0
- data/lib/mathjax-yard/init.rb +1 -1
- data/lib/mathjax-yard/version.rb +1 -1
- data/mathjax-yard.gemspec +2 -1
- data/mathjax.yml +4 -3
- metadata +28 -9
- data/mathjax.yml.bk +0 -28
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<script type="text/x-mathjax-config">
|
|
5
|
+
MathJax.Hub.Config({
|
|
6
|
+
tex2jax:{
|
|
7
|
+
inlineMath: [ ['$','$'], ["\(","\)"] ],
|
|
8
|
+
displayMath: [ ['$$','$$'], ["\[","\]"] ]
|
|
9
|
+
}
|
|
10
|
+
});
|
|
11
|
+
</script>
|
|
12
|
+
<script type="text/javascript"
|
|
13
|
+
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML">
|
|
14
|
+
</script>
|
|
15
|
+
<meta http-equiv="X-UA-Compatible" CONTENT="IE=EmulateIE7" />
|
|
16
|
+
<meta charset="UTF-8">
|
|
17
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
18
|
+
<title>
|
|
19
|
+
File: CODE_OF_CONDUCT
|
|
20
|
+
|
|
21
|
+
— Documentation by YARD 0.9.5
|
|
22
|
+
|
|
23
|
+
</title>
|
|
24
|
+
|
|
25
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
26
|
+
|
|
27
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
28
|
+
|
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
|
30
|
+
pathId = "CODE_OF_CONDUCT";
|
|
31
|
+
relpath = '';
|
|
32
|
+
</script>
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
36
|
+
|
|
37
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
</head>
|
|
41
|
+
<body>
|
|
42
|
+
<div class="nav_wrap">
|
|
43
|
+
<iframe id="nav" src="file_list.html"></iframe>
|
|
44
|
+
<div id="resizer"></div>
|
|
45
|
+
</div>
|
|
46
|
+
|
|
47
|
+
<div id="main" tabindex="-1">
|
|
48
|
+
<div id="header">
|
|
49
|
+
<div id="menu">
|
|
50
|
+
|
|
51
|
+
<a href="_index.html">Index</a> »
|
|
52
|
+
<span class="title">File: CODE_OF_CONDUCT</span>
|
|
53
|
+
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
<div id="search">
|
|
57
|
+
|
|
58
|
+
<a class="full_list_link" id="class_list_link"
|
|
59
|
+
href="class_list.html">
|
|
60
|
+
|
|
61
|
+
<svg width="24" height="24">
|
|
62
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
63
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
64
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
65
|
+
</svg>
|
|
66
|
+
</a>
|
|
67
|
+
|
|
68
|
+
</div>
|
|
69
|
+
<div class="clear"></div>
|
|
70
|
+
</div>
|
|
71
|
+
|
|
72
|
+
<iframe id="search_frame" src="file_list.html"></iframe>
|
|
73
|
+
|
|
74
|
+
<div id="content"><div id='filecontents'><h1>Contributor Code of Conduct</h1>
|
|
75
|
+
|
|
76
|
+
<p>As contributors and maintainers of this project, and in the interest of
|
|
77
|
+
fostering an open and welcoming community, we pledge to respect all people who
|
|
78
|
+
contribute through reporting issues, posting feature requests, updating
|
|
79
|
+
documentation, submitting pull requests or patches, and other activities.</p>
|
|
80
|
+
|
|
81
|
+
<p>We are committed to making participation in this project a harassment-free
|
|
82
|
+
experience for everyone, regardless of level of experience, gender, gender
|
|
83
|
+
identity and expression, sexual orientation, disability, personal appearance,
|
|
84
|
+
body size, race, ethnicity, age, religion, or nationality.</p>
|
|
85
|
+
|
|
86
|
+
<p>Examples of unacceptable behavior by participants include:</p>
|
|
87
|
+
|
|
88
|
+
<ul>
|
|
89
|
+
<li>The use of sexualized language or imagery</li>
|
|
90
|
+
<li>Personal attacks</li>
|
|
91
|
+
<li>Trolling or insulting/derogatory comments</li>
|
|
92
|
+
<li>Public or private harassment</li>
|
|
93
|
+
<li>Publishing other's private information, such as physical or electronic
|
|
94
|
+
addresses, without explicit permission</li>
|
|
95
|
+
<li>Other unethical or unprofessional conduct</li>
|
|
96
|
+
</ul>
|
|
97
|
+
|
|
98
|
+
<p>Project maintainers have the right and responsibility to remove, edit, or
|
|
99
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
|
100
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
|
101
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
|
102
|
+
threatening, offensive, or harmful.</p>
|
|
103
|
+
|
|
104
|
+
<p>By adopting this Code of Conduct, project maintainers commit themselves to
|
|
105
|
+
fairly and consistently applying these principles to every aspect of managing
|
|
106
|
+
this project. Project maintainers who do not follow or enforce the Code of
|
|
107
|
+
Conduct may be permanently removed from the project team.</p>
|
|
108
|
+
|
|
109
|
+
<p>This code of conduct applies both within project spaces and in public spaces
|
|
110
|
+
when an individual is representing the project or its community.</p>
|
|
111
|
+
|
|
112
|
+
<p>Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
113
|
+
reported by contacting a project maintainer at <a href="mailto:shigeto_nishitani@me.com">shigeto_nishitani@me.com</a>. All
|
|
114
|
+
complaints will be reviewed and investigated and will result in a response that
|
|
115
|
+
is deemed necessary and appropriate to the circumstances. Maintainers are
|
|
116
|
+
obligated to maintain confidentiality with regard to the reporter of an
|
|
117
|
+
incident.</p>
|
|
118
|
+
|
|
119
|
+
<p>This Code of Conduct is adapted from the <a href="http://contributor-covenant.org">Contributor Covenant</a>,
|
|
120
|
+
version 1.3.0, available at
|
|
121
|
+
<a href="http://contributor-covenant.org/version/1/3/0/">http://contributor-covenant.org/version/1/3/0/</a></p>
|
|
122
|
+
</div></div>
|
|
123
|
+
|
|
124
|
+
<div id="footer">
|
|
125
|
+
Generated on Wed Aug 17 18:27:24 2016 by
|
|
126
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
127
|
+
0.9.5 (ruby-2.2.2).
|
|
128
|
+
</div>
|
|
129
|
+
|
|
130
|
+
</div>
|
|
131
|
+
</body>
|
|
132
|
+
</html>
|
data/doc/file.Home.html
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
<!DOCTYPE html
|
|
2
|
-
|
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
4
3
|
<head>
|
|
5
4
|
<script type="text/x-mathjax-config">
|
|
6
5
|
MathJax.Hub.Config({
|
|
@@ -14,11 +13,12 @@
|
|
|
14
13
|
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML">
|
|
15
14
|
</script>
|
|
16
15
|
<meta http-equiv="X-UA-Compatible" CONTENT="IE=EmulateIE7" />
|
|
17
|
-
<meta
|
|
16
|
+
<meta charset="UTF-8">
|
|
17
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
18
18
|
<title>
|
|
19
19
|
File: Home
|
|
20
20
|
|
|
21
|
-
— Documentation by YARD 0.
|
|
21
|
+
— Documentation by YARD 0.9.5
|
|
22
22
|
|
|
23
23
|
</title>
|
|
24
24
|
|
|
@@ -27,9 +27,8 @@
|
|
|
27
27
|
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
28
28
|
|
|
29
29
|
<script type="text/javascript" charset="utf-8">
|
|
30
|
-
|
|
30
|
+
pathId = "Home";
|
|
31
31
|
relpath = '';
|
|
32
|
-
framesUrl = "frames.html#!file.Home.html";
|
|
33
32
|
</script>
|
|
34
33
|
|
|
35
34
|
|
|
@@ -40,49 +39,74 @@
|
|
|
40
39
|
|
|
41
40
|
</head>
|
|
42
41
|
<body>
|
|
43
|
-
<div
|
|
44
|
-
<
|
|
42
|
+
<div class="nav_wrap">
|
|
43
|
+
<iframe id="nav" src="file_list.html"></iframe>
|
|
44
|
+
<div id="resizer"></div>
|
|
45
|
+
</div>
|
|
46
|
+
|
|
47
|
+
<div id="main" tabindex="-1">
|
|
48
|
+
<div id="header">
|
|
49
|
+
<div id="menu">
|
|
45
50
|
|
|
46
51
|
<a href="_index.html">Index</a> »
|
|
47
52
|
<span class="title">File: Home</span>
|
|
48
53
|
|
|
49
|
-
|
|
50
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
51
54
|
</div>
|
|
52
55
|
|
|
53
|
-
|
|
56
|
+
<div id="search">
|
|
54
57
|
|
|
55
58
|
<a class="full_list_link" id="class_list_link"
|
|
56
59
|
href="class_list.html">
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
</a>
|
|
64
|
-
|
|
65
|
-
<a class="full_list_link" id="file_list_link"
|
|
66
|
-
href="file_list.html">
|
|
67
|
-
File List
|
|
60
|
+
|
|
61
|
+
<svg width="24" height="24">
|
|
62
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
63
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
64
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
65
|
+
</svg>
|
|
68
66
|
</a>
|
|
69
67
|
|
|
70
68
|
</div>
|
|
71
|
-
|
|
72
|
-
|
|
69
|
+
<div class="clear"></div>
|
|
70
|
+
</div>
|
|
73
71
|
|
|
74
|
-
|
|
72
|
+
<iframe id="search_frame" src="file_list.html"></iframe>
|
|
75
73
|
|
|
76
|
-
|
|
74
|
+
<div id="content"><div id='filecontents'><h1>MathJaxYard</h1>
|
|
77
75
|
|
|
78
76
|
<p>mathjax-yardはyardによるmarkdown変換においてmathjaxを使えるようにする拡張機能です．</p>
|
|
79
77
|
|
|
78
|
+
<p>Github, rubygemsなど，この文書をどのサイトで見るかによって見え方が変わります．</p>
|
|
79
|
+
|
|
80
80
|
<ul>
|
|
81
|
-
<li><a href="
|
|
82
|
-
<li><a href="file.atom.mjx.html">数式サンプル1</a></li>
|
|
83
|
-
<li><a href="file.potential.mjx.html">数式サンプル2</a></li>
|
|
81
|
+
<li><a href="http://nishitani0.kwansei.ac.jp/Open/mathjax-yard/">yardの出力見本</a></li>
|
|
84
82
|
</ul>
|
|
85
83
|
|
|
84
|
+
<p>が，mathjax-yardで意図している完成形です．そこから数式サンプルをたどってみてください．綺麗に数式が表示されるはず．</p>
|
|
85
|
+
|
|
86
|
+
<table><thead>
|
|
87
|
+
<tr>
|
|
88
|
+
<th style="text-align: left">項目</th>
|
|
89
|
+
<th style="text-align: left">from gems</th>
|
|
90
|
+
<th style="text-align: left">for github</th>
|
|
91
|
+
</tr>
|
|
92
|
+
</thead><tbody>
|
|
93
|
+
<tr>
|
|
94
|
+
<td style="text-align: left">なぜ開発したか</td>
|
|
95
|
+
<td style="text-align: left"><a href="file.Why_mathjax-yard.mjx.html">gems</a></td>
|
|
96
|
+
<td style="text-align: left"><a href="Why_mathjax-yard">wiki</a></td>
|
|
97
|
+
</tr>
|
|
98
|
+
<tr>
|
|
99
|
+
<td style="text-align: left">数式サンプル1</td>
|
|
100
|
+
<td style="text-align: left"><a href="file.atom.mjx.html">gems</a></td>
|
|
101
|
+
<td style="text-align: left"><a href="atom">gems</a></td>
|
|
102
|
+
</tr>
|
|
103
|
+
<tr>
|
|
104
|
+
<td style="text-align: left">数式サンプル2</td>
|
|
105
|
+
<td style="text-align: left"><a href="file.potential.mjx.html">gems</a></td>
|
|
106
|
+
<td style="text-align: left"><a href="potential">gems</a></td>
|
|
107
|
+
</tr>
|
|
108
|
+
</tbody></table>
|
|
109
|
+
|
|
86
110
|
<h2>Installation</h2>
|
|
87
111
|
|
|
88
112
|
<p>Add this line to your application's Gemfile:</p>
|
|
@@ -90,6 +114,14 @@
|
|
|
90
114
|
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>'</span></span>
|
|
91
115
|
</code></pre>
|
|
92
116
|
|
|
117
|
+
<p>or</p>
|
|
118
|
+
|
|
119
|
+
<pre class="code ruby"><code class="ruby">Gem::Specification.new do |spec|
|
|
120
|
+
...
|
|
121
|
+
spec.add_development_dependency "mathjax-yard", "~> 1.0.2"
|
|
122
|
+
end
|
|
123
|
+
</code></pre>
|
|
124
|
+
|
|
93
125
|
<p>And then execute:</p>
|
|
94
126
|
|
|
95
127
|
<pre class="code ruby"><code class="ruby">$ bundle
|
|
@@ -102,57 +134,71 @@
|
|
|
102
134
|
|
|
103
135
|
<h2>Usage</h2>
|
|
104
136
|
|
|
105
|
-
<p>mathjax-yard
|
|
137
|
+
<p>mathjax-yardは，bundle gemで作られるgemの開発directoryでの文書作成を前提に作られています．</p>
|
|
106
138
|
|
|
107
|
-
<
|
|
108
|
-
<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:yard</span> <span class='kw'>do</span>
|
|
109
|
-
<span class='const'>YARD</span><span class='op'>::</span><span class='const'>Rake</span><span class='op'>::</span><span class='const'>YardocTask</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
110
|
-
<span class='kw'>end</span>
|
|
139
|
+
<h3>準備</h3>
|
|
111
140
|
|
|
112
|
-
<
|
|
113
|
-
<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:pre_math</span> <span class='kw'>do</span>
|
|
114
|
-
<span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
115
|
-
<span class='kw'>end</span>
|
|
141
|
+
<p>yardのoptionは，.yardoptsに</p>
|
|
116
142
|
|
|
117
|
-
<
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
143
|
+
<pre class="code ruby"><code class="ruby">-t mathjax -p templates
|
|
144
|
+
-
|
|
145
|
+
spec/*.md
|
|
146
|
+
</code></pre>
|
|
147
|
+
|
|
148
|
+
<p>としています．</p>
|
|
149
|
+
|
|
150
|
+
<p>htmlのhead部分にmathjaxのscriptを埋め込んだlayoutを用意する必要があります．
|
|
151
|
+
mathjax-yardでは，</p>
|
|
152
|
+
|
|
153
|
+
<pre class="code csh"><code class="csh"> mathjax-yard --init
|
|
154
|
+
</code></pre>
|
|
155
|
+
|
|
156
|
+
<p>で自動生成します．</p>
|
|
157
|
+
|
|
158
|
+
<p>その他に，Rakefile, .yardoptsに記述の追加が必要ですが，今は手動で行うように指示しています．</p>
|
|
159
|
+
|
|
160
|
+
<h2>Usage</h2>
|
|
161
|
+
|
|
162
|
+
<pre class="code csh"><code class="csh">Usage: mathjax-yard [options] [DIRECTORY]
|
|
163
|
+
with no extention: mathjax-yard -p lib/../*/*.md
|
|
164
|
+
|
|
165
|
+
-v, --version show program Version.
|
|
166
|
+
-r, --revert revert mjx file to orig file.
|
|
167
|
+
-p, --pre pre operation.
|
|
168
|
+
--post post operation.
|
|
169
|
+
-i, --init init for mathjax on yard layout.
|
|
121
170
|
</code></pre>
|
|
122
171
|
|
|
123
172
|
<p>yardのデフォルトでの動作をなぞって，動作するように作られています．</p>
|
|
124
173
|
|
|
125
174
|
<ul>
|
|
126
175
|
<li>mathjax-yardは./<em>/</em>.mdを探索し，それらの中に'\$\$'あるいは'\$\$..\$\$'があると\$MATHJAX20\$などというタグに付け替え，</li>
|
|
127
|
-
<li
|
|
128
|
-
<li
|
|
176
|
+
<li>*.mjx.mdとしたファイルに元ファイルのバックアップを取り，タグ付け替えした内容を保存します．</li>
|
|
177
|
+
<li>また，同時に，'mathjax.yml'にそれらのhash関係をyaml形式で保存します．</li>
|
|
129
178
|
<li>通常のrake yardで変換したのち，</li>
|
|
130
179
|
<li>'mathjax-yard --post'によって，'doc/file.*.mjx.html'に残されたtagを元に戻します．</li>
|
|
131
180
|
<li>また同時に，mjx.mdファイルを消します．</li>
|
|
181
|
+
<li>doc中には，files.<em>.mjx.htmlとfiles.</em>.htmlという2種類のほぼ同じ内容のhtmlが生成されます．</li>
|
|
132
182
|
</ul>
|
|
133
183
|
|
|
134
|
-
<
|
|
135
|
-
|
|
136
|
-
<pre class="code ruby"><code class="ruby">-t mathjax -p templates
|
|
137
|
-
-
|
|
138
|
-
spec/*.md
|
|
139
|
-
</code></pre>
|
|
184
|
+
<h3>Rakefileでの使用例</h3>
|
|
140
185
|
|
|
141
|
-
<p
|
|
186
|
+
<p>Rakefileでの使用例は次の通りです．</p>
|
|
142
187
|
|
|
143
|
-
<
|
|
144
|
-
|
|
145
|
-
<
|
|
146
|
-
</
|
|
188
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>make documents by yard</span><span class='tstring_end'>"</span></span>
|
|
189
|
+
<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:yard</span> <span class='kw'>do</span>
|
|
190
|
+
<span class='const'>YARD</span><span class='op'>::</span><span class='const'>Rake</span><span class='op'>::</span><span class='const'>YardocTask</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
191
|
+
<span class='kw'>end</span>
|
|
147
192
|
|
|
148
|
-
<
|
|
193
|
+
<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>arrange yard target by mathjax-yard</span><span class='tstring_end'>"</span></span>
|
|
194
|
+
<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:pre_math</span> <span class='kw'>do</span>
|
|
195
|
+
<span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
196
|
+
<span class='kw'>end</span>
|
|
149
197
|
|
|
150
|
-
<
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
-p, --post post operation.
|
|
155
|
-
-i, --init initiation for mathjax extension on yard layout.
|
|
198
|
+
<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>make yard documents with yardmath</span><span class='tstring_end'>"</span></span>
|
|
199
|
+
<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:myard</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='symbol'>:pre_math</span><span class='comma'>,</span><span class='symbol'>:yard</span><span class='rbracket'>]</span> <span class='kw'>do</span>
|
|
200
|
+
<span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mathjax-yard --post</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
201
|
+
<span class='kw'>end</span>
|
|
156
202
|
</code></pre>
|
|
157
203
|
|
|
158
204
|
<h2>Development</h2>
|
|
@@ -161,6 +207,12 @@ Usage: yardmath [options] [DIRECTORY]
|
|
|
161
207
|
|
|
162
208
|
<p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
|
|
163
209
|
|
|
210
|
+
<h2>left issues</h2>
|
|
211
|
+
|
|
212
|
+
<ul>
|
|
213
|
+
<li><a href="file.Why_mathjax-yard.html">残された課題</a>のやり残しに既述．</li>
|
|
214
|
+
</ul>
|
|
215
|
+
|
|
164
216
|
<h2>Contributing</h2>
|
|
165
217
|
|
|
166
218
|
<p>Bug reports and pull requests are welcome on GitHub at [[<a href="https://github.com/%5BUSERNAME%5D/mathjax-yard%5D">https://github.com/[USERNAME]/mathjax-yard]</a>]. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the <a href="http://contributor-covenant.org">Contributor Covenant</a> code of conduct.</p>
|
|
@@ -170,11 +222,12 @@ Usage: yardmath [options] [DIRECTORY]
|
|
|
170
222
|
<p>The gem is available as open source under the terms of the <a href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
171
223
|
</div></div>
|
|
172
224
|
|
|
173
|
-
|
|
174
|
-
Generated on
|
|
225
|
+
<div id="footer">
|
|
226
|
+
Generated on Wed Aug 17 18:27:24 2016 by
|
|
175
227
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
176
|
-
0.
|
|
228
|
+
0.9.5 (ruby-2.2.2).
|
|
177
229
|
</div>
|
|
178
230
|
|
|
231
|
+
</div>
|
|
179
232
|
</body>
|
|
180
233
|
</html>
|
data/doc/file.README.html
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
<!DOCTYPE html
|
|
2
|
-
|
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
4
3
|
<head>
|
|
5
4
|
<script type="text/x-mathjax-config">
|
|
6
5
|
MathJax.Hub.Config({
|
|
@@ -14,11 +13,12 @@
|
|
|
14
13
|
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML">
|
|
15
14
|
</script>
|
|
16
15
|
<meta http-equiv="X-UA-Compatible" CONTENT="IE=EmulateIE7" />
|
|
17
|
-
<meta
|
|
16
|
+
<meta charset="UTF-8">
|
|
17
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
18
18
|
<title>
|
|
19
19
|
File: README
|
|
20
20
|
|
|
21
|
-
— Documentation by YARD 0.
|
|
21
|
+
— Documentation by YARD 0.9.5
|
|
22
22
|
|
|
23
23
|
</title>
|
|
24
24
|
|
|
@@ -27,9 +27,8 @@
|
|
|
27
27
|
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
28
28
|
|
|
29
29
|
<script type="text/javascript" charset="utf-8">
|
|
30
|
-
|
|
30
|
+
pathId = "README";
|
|
31
31
|
relpath = '';
|
|
32
|
-
framesUrl = "frames.html#!file.README.html";
|
|
33
32
|
</script>
|
|
34
33
|
|
|
35
34
|
|
|
@@ -40,49 +39,74 @@
|
|
|
40
39
|
|
|
41
40
|
</head>
|
|
42
41
|
<body>
|
|
43
|
-
<div
|
|
44
|
-
<
|
|
42
|
+
<div class="nav_wrap">
|
|
43
|
+
<iframe id="nav" src="file_list.html"></iframe>
|
|
44
|
+
<div id="resizer"></div>
|
|
45
|
+
</div>
|
|
46
|
+
|
|
47
|
+
<div id="main" tabindex="-1">
|
|
48
|
+
<div id="header">
|
|
49
|
+
<div id="menu">
|
|
45
50
|
|
|
46
51
|
<a href="_index.html">Index</a> »
|
|
47
52
|
<span class="title">File: README</span>
|
|
48
53
|
|
|
49
|
-
|
|
50
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
51
54
|
</div>
|
|
52
55
|
|
|
53
|
-
|
|
56
|
+
<div id="search">
|
|
54
57
|
|
|
55
58
|
<a class="full_list_link" id="class_list_link"
|
|
56
59
|
href="class_list.html">
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
</a>
|
|
64
|
-
|
|
65
|
-
<a class="full_list_link" id="file_list_link"
|
|
66
|
-
href="file_list.html">
|
|
67
|
-
File List
|
|
60
|
+
|
|
61
|
+
<svg width="24" height="24">
|
|
62
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
63
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
64
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
65
|
+
</svg>
|
|
68
66
|
</a>
|
|
69
67
|
|
|
70
68
|
</div>
|
|
71
|
-
|
|
72
|
-
|
|
69
|
+
<div class="clear"></div>
|
|
70
|
+
</div>
|
|
73
71
|
|
|
74
|
-
|
|
72
|
+
<iframe id="search_frame" src="file_list.html"></iframe>
|
|
75
73
|
|
|
76
|
-
|
|
74
|
+
<div id="content"><div id='filecontents'><h1>MathJaxYard</h1>
|
|
77
75
|
|
|
78
76
|
<p>mathjax-yardはyardによるmarkdown変換においてmathjaxを使えるようにする拡張機能です．</p>
|
|
79
77
|
|
|
78
|
+
<p>Github, rubygemsなど，この文書をどのサイトで見るかによって見え方が変わります．</p>
|
|
79
|
+
|
|
80
80
|
<ul>
|
|
81
|
-
<li><a href="
|
|
82
|
-
<li><a href="file.atom.mjx.html">数式サンプル1</a></li>
|
|
83
|
-
<li><a href="file.potential.mjx.html">数式サンプル2</a></li>
|
|
81
|
+
<li><a href="http://nishitani0.kwansei.ac.jp/Open/mathjax-yard/">yardの出力見本</a></li>
|
|
84
82
|
</ul>
|
|
85
83
|
|
|
84
|
+
<p>が，mathjax-yardで意図している完成形です．そこから数式サンプルをたどってみてください．綺麗に数式が表示されるはず．</p>
|
|
85
|
+
|
|
86
|
+
<table><thead>
|
|
87
|
+
<tr>
|
|
88
|
+
<th style="text-align: left">項目</th>
|
|
89
|
+
<th style="text-align: left">from gems</th>
|
|
90
|
+
<th style="text-align: left">for github</th>
|
|
91
|
+
</tr>
|
|
92
|
+
</thead><tbody>
|
|
93
|
+
<tr>
|
|
94
|
+
<td style="text-align: left">なぜ開発したか</td>
|
|
95
|
+
<td style="text-align: left"><a href="file.Why_mathjax-yard.mjx.html">gems</a></td>
|
|
96
|
+
<td style="text-align: left"><a href="Why_mathjax-yard">wiki</a></td>
|
|
97
|
+
</tr>
|
|
98
|
+
<tr>
|
|
99
|
+
<td style="text-align: left">数式サンプル1</td>
|
|
100
|
+
<td style="text-align: left"><a href="file.atom.mjx.html">gems</a></td>
|
|
101
|
+
<td style="text-align: left"><a href="atom">gems</a></td>
|
|
102
|
+
</tr>
|
|
103
|
+
<tr>
|
|
104
|
+
<td style="text-align: left">数式サンプル2</td>
|
|
105
|
+
<td style="text-align: left"><a href="file.potential.mjx.html">gems</a></td>
|
|
106
|
+
<td style="text-align: left"><a href="potential">gems</a></td>
|
|
107
|
+
</tr>
|
|
108
|
+
</tbody></table>
|
|
109
|
+
|
|
86
110
|
<h2>Installation</h2>
|
|
87
111
|
|
|
88
112
|
<p>Add this line to your application's Gemfile:</p>
|
|
@@ -90,6 +114,14 @@
|
|
|
90
114
|
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>'</span></span>
|
|
91
115
|
</code></pre>
|
|
92
116
|
|
|
117
|
+
<p>or</p>
|
|
118
|
+
|
|
119
|
+
<pre class="code ruby"><code class="ruby">Gem::Specification.new do |spec|
|
|
120
|
+
...
|
|
121
|
+
spec.add_development_dependency "mathjax-yard", "~> 1.0.2"
|
|
122
|
+
end
|
|
123
|
+
</code></pre>
|
|
124
|
+
|
|
93
125
|
<p>And then execute:</p>
|
|
94
126
|
|
|
95
127
|
<pre class="code ruby"><code class="ruby">$ bundle
|
|
@@ -102,57 +134,71 @@
|
|
|
102
134
|
|
|
103
135
|
<h2>Usage</h2>
|
|
104
136
|
|
|
105
|
-
<p>mathjax-yard
|
|
137
|
+
<p>mathjax-yardは，bundle gemで作られるgemの開発directoryでの文書作成を前提に作られています．</p>
|
|
106
138
|
|
|
107
|
-
<
|
|
108
|
-
<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:yard</span> <span class='kw'>do</span>
|
|
109
|
-
<span class='const'>YARD</span><span class='op'>::</span><span class='const'>Rake</span><span class='op'>::</span><span class='const'>YardocTask</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
110
|
-
<span class='kw'>end</span>
|
|
139
|
+
<h3>準備</h3>
|
|
111
140
|
|
|
112
|
-
<
|
|
113
|
-
<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:pre_math</span> <span class='kw'>do</span>
|
|
114
|
-
<span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
115
|
-
<span class='kw'>end</span>
|
|
141
|
+
<p>yardのoptionは，.yardoptsに</p>
|
|
116
142
|
|
|
117
|
-
<
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
143
|
+
<pre class="code ruby"><code class="ruby">-t mathjax -p templates
|
|
144
|
+
-
|
|
145
|
+
spec/*.md
|
|
146
|
+
</code></pre>
|
|
147
|
+
|
|
148
|
+
<p>としています．</p>
|
|
149
|
+
|
|
150
|
+
<p>htmlのhead部分にmathjaxのscriptを埋め込んだlayoutを用意する必要があります．
|
|
151
|
+
mathjax-yardでは，</p>
|
|
152
|
+
|
|
153
|
+
<pre class="code csh"><code class="csh"> mathjax-yard --init
|
|
154
|
+
</code></pre>
|
|
155
|
+
|
|
156
|
+
<p>で自動生成します．</p>
|
|
157
|
+
|
|
158
|
+
<p>その他に，Rakefile, .yardoptsに記述の追加が必要ですが，今は手動で行うように指示しています．</p>
|
|
159
|
+
|
|
160
|
+
<h2>Usage</h2>
|
|
161
|
+
|
|
162
|
+
<pre class="code csh"><code class="csh">Usage: mathjax-yard [options] [DIRECTORY]
|
|
163
|
+
with no extention: mathjax-yard -p lib/../*/*.md
|
|
164
|
+
|
|
165
|
+
-v, --version show program Version.
|
|
166
|
+
-r, --revert revert mjx file to orig file.
|
|
167
|
+
-p, --pre pre operation.
|
|
168
|
+
--post post operation.
|
|
169
|
+
-i, --init init for mathjax on yard layout.
|
|
121
170
|
</code></pre>
|
|
122
171
|
|
|
123
172
|
<p>yardのデフォルトでの動作をなぞって，動作するように作られています．</p>
|
|
124
173
|
|
|
125
174
|
<ul>
|
|
126
175
|
<li>mathjax-yardは./<em>/</em>.mdを探索し，それらの中に'\$\$'あるいは'\$\$..\$\$'があると\$MATHJAX20\$などというタグに付け替え，</li>
|
|
127
|
-
<li
|
|
128
|
-
<li
|
|
176
|
+
<li>*.mjx.mdとしたファイルに元ファイルのバックアップを取り，タグ付け替えした内容を保存します．</li>
|
|
177
|
+
<li>また，同時に，'mathjax.yml'にそれらのhash関係をyaml形式で保存します．</li>
|
|
129
178
|
<li>通常のrake yardで変換したのち，</li>
|
|
130
179
|
<li>'mathjax-yard --post'によって，'doc/file.*.mjx.html'に残されたtagを元に戻します．</li>
|
|
131
180
|
<li>また同時に，mjx.mdファイルを消します．</li>
|
|
181
|
+
<li>doc中には，files.<em>.mjx.htmlとfiles.</em>.htmlという2種類のほぼ同じ内容のhtmlが生成されます．</li>
|
|
132
182
|
</ul>
|
|
133
183
|
|
|
134
|
-
<
|
|
135
|
-
|
|
136
|
-
<pre class="code ruby"><code class="ruby">-t mathjax -p templates
|
|
137
|
-
-
|
|
138
|
-
spec/*.md
|
|
139
|
-
</code></pre>
|
|
184
|
+
<h3>Rakefileでの使用例</h3>
|
|
140
185
|
|
|
141
|
-
<p
|
|
186
|
+
<p>Rakefileでの使用例は次の通りです．</p>
|
|
142
187
|
|
|
143
|
-
<
|
|
144
|
-
|
|
145
|
-
<
|
|
146
|
-
</
|
|
188
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>make documents by yard</span><span class='tstring_end'>"</span></span>
|
|
189
|
+
<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:yard</span> <span class='kw'>do</span>
|
|
190
|
+
<span class='const'>YARD</span><span class='op'>::</span><span class='const'>Rake</span><span class='op'>::</span><span class='const'>YardocTask</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
191
|
+
<span class='kw'>end</span>
|
|
147
192
|
|
|
148
|
-
<
|
|
193
|
+
<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>arrange yard target by mathjax-yard</span><span class='tstring_end'>"</span></span>
|
|
194
|
+
<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:pre_math</span> <span class='kw'>do</span>
|
|
195
|
+
<span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
196
|
+
<span class='kw'>end</span>
|
|
149
197
|
|
|
150
|
-
<
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
-p, --post post operation.
|
|
155
|
-
-i, --init initiation for mathjax extension on yard layout.
|
|
198
|
+
<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>make yard documents with yardmath</span><span class='tstring_end'>"</span></span>
|
|
199
|
+
<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:myard</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='symbol'>:pre_math</span><span class='comma'>,</span><span class='symbol'>:yard</span><span class='rbracket'>]</span> <span class='kw'>do</span>
|
|
200
|
+
<span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mathjax-yard --post</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
201
|
+
<span class='kw'>end</span>
|
|
156
202
|
</code></pre>
|
|
157
203
|
|
|
158
204
|
<h2>Development</h2>
|
|
@@ -161,6 +207,12 @@ Usage: yardmath [options] [DIRECTORY]
|
|
|
161
207
|
|
|
162
208
|
<p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
|
|
163
209
|
|
|
210
|
+
<h2>left issues</h2>
|
|
211
|
+
|
|
212
|
+
<ul>
|
|
213
|
+
<li><a href="file.Why_mathjax-yard.html">残された課題</a>のやり残しに既述．</li>
|
|
214
|
+
</ul>
|
|
215
|
+
|
|
164
216
|
<h2>Contributing</h2>
|
|
165
217
|
|
|
166
218
|
<p>Bug reports and pull requests are welcome on GitHub at [[<a href="https://github.com/%5BUSERNAME%5D/mathjax-yard%5D">https://github.com/[USERNAME]/mathjax-yard]</a>]. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the <a href="http://contributor-covenant.org">Contributor Covenant</a> code of conduct.</p>
|
|
@@ -170,11 +222,12 @@ Usage: yardmath [options] [DIRECTORY]
|
|
|
170
222
|
<p>The gem is available as open source under the terms of the <a href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
171
223
|
</div></div>
|
|
172
224
|
|
|
173
|
-
|
|
174
|
-
Generated on
|
|
225
|
+
<div id="footer">
|
|
226
|
+
Generated on Wed Aug 17 18:27:24 2016 by
|
|
175
227
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
176
|
-
0.
|
|
228
|
+
0.9.5 (ruby-2.2.2).
|
|
177
229
|
</div>
|
|
178
230
|
|
|
231
|
+
</div>
|
|
179
232
|
</body>
|
|
180
233
|
</html>
|