mathjax-yard 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
data/doc/method_list.html
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
<!DOCTYPE html
|
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
1
|
+
<!DOCTYPE html>
|
|
3
2
|
<html>
|
|
4
3
|
<head>
|
|
5
|
-
<meta
|
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
5
|
+
<meta charset="utf-8" />
|
|
6
6
|
|
|
7
7
|
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
|
8
8
|
|
|
@@ -19,116 +19,144 @@
|
|
|
19
19
|
<base id="base_target" target="_parent" />
|
|
20
20
|
</head>
|
|
21
21
|
<body>
|
|
22
|
-
<script type="text/javascript" charset="utf-8">
|
|
23
|
-
var hasFrames = false;
|
|
24
|
-
try {
|
|
25
|
-
hasFrames = window.top.frames.main ? true : false;
|
|
26
|
-
} catch (e) { }
|
|
27
|
-
if (hasFrames) {
|
|
28
|
-
document.getElementById('base_target').target = 'main';
|
|
29
|
-
document.body.className = 'frames';
|
|
30
|
-
}
|
|
31
|
-
</script>
|
|
32
22
|
<div id="content">
|
|
33
|
-
<
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
23
|
+
<div class="fixed_header">
|
|
24
|
+
<h1 id="full_list_header">Method List</h1>
|
|
25
|
+
<div id="full_list_nav">
|
|
26
|
+
|
|
27
|
+
<span><a target="_self" href="class_list.html">
|
|
28
|
+
Classes
|
|
29
|
+
</a></span>
|
|
30
|
+
|
|
31
|
+
<span><a target="_self" href="method_list.html">
|
|
32
|
+
Methods
|
|
33
|
+
</a></span>
|
|
34
|
+
|
|
35
|
+
<span><a target="_self" href="file_list.html">
|
|
36
|
+
Files
|
|
37
|
+
</a></span>
|
|
38
|
+
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
|
48
42
|
</div>
|
|
49
|
-
<div id="search">Search: <input type="text" /></div>
|
|
50
43
|
|
|
51
44
|
<ul id="full_list" class="method">
|
|
52
45
|
|
|
53
46
|
|
|
54
|
-
<li class="
|
|
55
|
-
<
|
|
56
|
-
|
|
47
|
+
<li class="odd ">
|
|
48
|
+
<div class="item">
|
|
49
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#convert-instance_method" title="MathJaxYard::Command#convert (method)">#convert</a></span>
|
|
50
|
+
<small>MathJaxYard::Command</small>
|
|
51
|
+
</div>
|
|
57
52
|
</li>
|
|
58
53
|
|
|
59
54
|
|
|
60
|
-
<li class="
|
|
61
|
-
<
|
|
62
|
-
|
|
55
|
+
<li class="even ">
|
|
56
|
+
<div class="item">
|
|
57
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#execute-instance_method" title="MathJaxYard::Command#execute (method)">#execute</a></span>
|
|
58
|
+
<small>MathJaxYard::Command</small>
|
|
59
|
+
</div>
|
|
63
60
|
</li>
|
|
64
61
|
|
|
65
62
|
|
|
66
|
-
<li class="
|
|
67
|
-
<
|
|
68
|
-
|
|
63
|
+
<li class="odd ">
|
|
64
|
+
<div class="item">
|
|
65
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#get_yard_layout_dir-instance_method" title="MathJaxYard::Command#get_yard_layout_dir (method)">#get_yard_layout_dir</a></span>
|
|
66
|
+
<small>MathJaxYard::Command</small>
|
|
67
|
+
</div>
|
|
68
|
+
</li>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
<li class="even ">
|
|
72
|
+
<div class="item">
|
|
73
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#init_mathjax_yard-instance_method" title="MathJaxYard::Command#init_mathjax_yard (method)">#init_mathjax_yard</a></span>
|
|
74
|
+
<small>MathJaxYard::Command</small>
|
|
75
|
+
</div>
|
|
69
76
|
</li>
|
|
70
77
|
|
|
71
78
|
|
|
72
|
-
<li class="
|
|
73
|
-
<
|
|
74
|
-
|
|
79
|
+
<li class="odd ">
|
|
80
|
+
<div class="item">
|
|
81
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#init_yard-instance_method" title="MathJaxYard::Command#init_yard (method)">#init_yard</a></span>
|
|
82
|
+
<small>MathJaxYard::Command</small>
|
|
83
|
+
</div>
|
|
75
84
|
</li>
|
|
76
85
|
|
|
77
86
|
|
|
78
|
-
<li class="
|
|
79
|
-
<
|
|
80
|
-
|
|
87
|
+
<li class="even ">
|
|
88
|
+
<div class="item">
|
|
89
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#initialize-instance_method" title="MathJaxYard::Command#initialize (method)">#initialize</a></span>
|
|
90
|
+
<small>MathJaxYard::Command</small>
|
|
91
|
+
</div>
|
|
81
92
|
</li>
|
|
82
93
|
|
|
83
94
|
|
|
84
|
-
<li class="
|
|
85
|
-
<
|
|
86
|
-
|
|
95
|
+
<li class="odd ">
|
|
96
|
+
<div class="item">
|
|
97
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#mk_mjx_file_name-instance_method" title="MathJaxYard::Command#mk_mjx_file_name (method)">#mk_mjx_file_name</a></span>
|
|
98
|
+
<small>MathJaxYard::Command</small>
|
|
99
|
+
</div>
|
|
87
100
|
</li>
|
|
88
101
|
|
|
89
102
|
|
|
90
|
-
<li class="
|
|
91
|
-
<
|
|
92
|
-
|
|
103
|
+
<li class="even ">
|
|
104
|
+
<div class="item">
|
|
105
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#mk_tags-instance_method" title="MathJaxYard::Command#mk_tags (method)">#mk_tags</a></span>
|
|
106
|
+
<small>MathJaxYard::Command</small>
|
|
107
|
+
</div>
|
|
93
108
|
</li>
|
|
94
109
|
|
|
95
110
|
|
|
96
|
-
<li class="
|
|
97
|
-
<
|
|
98
|
-
|
|
111
|
+
<li class="odd ">
|
|
112
|
+
<div class="item">
|
|
113
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#modify_layout-instance_method" title="MathJaxYard::Command#modify_layout (method)">#modify_layout</a></span>
|
|
114
|
+
<small>MathJaxYard::Command</small>
|
|
115
|
+
</div>
|
|
99
116
|
</li>
|
|
100
117
|
|
|
101
118
|
|
|
102
|
-
<li class="
|
|
103
|
-
<
|
|
104
|
-
|
|
119
|
+
<li class="even ">
|
|
120
|
+
<div class="item">
|
|
121
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#post_operation-instance_method" title="MathJaxYard::Command#post_operation (method)">#post_operation</a></span>
|
|
122
|
+
<small>MathJaxYard::Command</small>
|
|
123
|
+
</div>
|
|
105
124
|
</li>
|
|
106
125
|
|
|
107
126
|
|
|
108
|
-
<li class="
|
|
109
|
-
<
|
|
110
|
-
|
|
127
|
+
<li class="odd ">
|
|
128
|
+
<div class="item">
|
|
129
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#revert-instance_method" title="MathJaxYard::Command#revert (method)">#revert</a></span>
|
|
130
|
+
<small>MathJaxYard::Command</small>
|
|
131
|
+
</div>
|
|
111
132
|
</li>
|
|
112
133
|
|
|
113
134
|
|
|
114
|
-
<li class="
|
|
115
|
-
<
|
|
116
|
-
|
|
135
|
+
<li class="even ">
|
|
136
|
+
<div class="item">
|
|
137
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#run-class_method" title="MathJaxYard::Command.run (method)">run</a></span>
|
|
138
|
+
<small>MathJaxYard::Command</small>
|
|
139
|
+
</div>
|
|
117
140
|
</li>
|
|
118
141
|
|
|
119
142
|
|
|
120
|
-
<li class="
|
|
121
|
-
<
|
|
122
|
-
|
|
143
|
+
<li class="odd ">
|
|
144
|
+
<div class="item">
|
|
145
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#store_eq_data-instance_method" title="MathJaxYard::Command#store_eq_data (method)">#store_eq_data</a></span>
|
|
146
|
+
<small>MathJaxYard::Command</small>
|
|
147
|
+
</div>
|
|
123
148
|
</li>
|
|
124
149
|
|
|
125
150
|
|
|
126
|
-
<li class="
|
|
127
|
-
<
|
|
128
|
-
|
|
151
|
+
<li class="even ">
|
|
152
|
+
<div class="item">
|
|
153
|
+
<span class='object_link'><a href="MathJaxYard/Command.html#write_output_on_target-instance_method" title="MathJaxYard::Command#write_output_on_target (method)">#write_output_on_target</a></span>
|
|
154
|
+
<small>MathJaxYard::Command</small>
|
|
155
|
+
</div>
|
|
129
156
|
</li>
|
|
130
157
|
|
|
131
158
|
|
|
159
|
+
|
|
132
160
|
</ul>
|
|
133
161
|
</div>
|
|
134
162
|
</body>
|
|
@@ -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
|
Top Level Namespace
|
|
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 = "";
|
|
31
31
|
relpath = '';
|
|
32
|
-
framesUrl = "frames.html#!top-level-namespace.html";
|
|
33
32
|
</script>
|
|
34
33
|
|
|
35
34
|
|
|
@@ -40,58 +39,58 @@
|
|
|
40
39
|
|
|
41
40
|
</head>
|
|
42
41
|
<body>
|
|
43
|
-
<div
|
|
44
|
-
<
|
|
42
|
+
<div class="nav_wrap">
|
|
43
|
+
<iframe id="nav" src="class_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
|
|
|
48
53
|
|
|
49
54
|
<span class="title">Top Level Namespace</span>
|
|
50
55
|
|
|
51
|
-
|
|
52
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
53
56
|
</div>
|
|
54
57
|
|
|
55
|
-
|
|
58
|
+
<div id="search">
|
|
56
59
|
|
|
57
60
|
<a class="full_list_link" id="class_list_link"
|
|
58
61
|
href="class_list.html">
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
</a>
|
|
66
|
-
|
|
67
|
-
<a class="full_list_link" id="file_list_link"
|
|
68
|
-
href="file_list.html">
|
|
69
|
-
File List
|
|
62
|
+
|
|
63
|
+
<svg width="24" height="24">
|
|
64
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
65
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
66
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
67
|
+
</svg>
|
|
70
68
|
</a>
|
|
71
69
|
|
|
72
70
|
</div>
|
|
73
|
-
|
|
74
|
-
|
|
71
|
+
<div class="clear"></div>
|
|
72
|
+
</div>
|
|
75
73
|
|
|
76
|
-
|
|
74
|
+
<iframe id="search_frame" src="class_list.html"></iframe>
|
|
77
75
|
|
|
78
|
-
|
|
76
|
+
<div id="content"><h1>Top Level Namespace
|
|
79
77
|
|
|
80
78
|
|
|
81
79
|
|
|
82
80
|
</h1>
|
|
81
|
+
<div class="box_info">
|
|
82
|
+
|
|
83
83
|
|
|
84
|
-
<dl class="box">
|
|
85
84
|
|
|
86
85
|
|
|
87
|
-
|
|
88
86
|
|
|
89
|
-
|
|
90
87
|
|
|
91
88
|
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
92
|
|
|
93
|
-
</
|
|
94
|
-
<div class="clear"></div>
|
|
93
|
+
</div>
|
|
95
94
|
|
|
96
95
|
<h2>Defined Under Namespace</h2>
|
|
97
96
|
<p class="children">
|
|
@@ -105,13 +104,12 @@
|
|
|
105
104
|
</p>
|
|
106
105
|
|
|
107
106
|
<h2>Constant Summary</h2>
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
<dd><pre class="code"><span class='heredoc_beg'><<EOS</span>
|
|
107
|
+
<dl class="constants">
|
|
108
|
+
|
|
109
|
+
<dt id="MATH_SCRIPT-constant" class="">MATH_SCRIPT =
|
|
110
|
+
|
|
111
|
+
</dt>
|
|
112
|
+
<dd><pre class="code"><span class='heredoc_beg'><<EOS</span>
|
|
115
113
|
<span class='tstring_content'> <script type="text/x-mathjax-config">
|
|
116
114
|
MathJax.Hub.Config({
|
|
117
115
|
tex2jax:{
|
|
@@ -126,17 +124,16 @@ S_HTML">
|
|
|
126
124
|
</script>
|
|
127
125
|
<meta http-equiv="X-UA-Compatible" CONTENT="IE=EmulateIE7" />
|
|
128
126
|
</span><span class='heredoc_end'>EOS</span></pre></dd>
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
127
|
+
|
|
128
|
+
<dt id="ORIGINAL-constant" class="">ORIGINAL =
|
|
129
|
+
|
|
130
|
+
</dt>
|
|
131
|
+
<dd><pre class="code"><span class='heredoc_beg'><<EOS</span>
|
|
134
132
|
<span class='tstring_content'> <%= erb(:headers) %>
|
|
135
133
|
</head>
|
|
136
134
|
</span><span class='heredoc_end'>EOS</span></pre></dd>
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
135
|
+
|
|
136
|
+
</dl>
|
|
140
137
|
|
|
141
138
|
|
|
142
139
|
|
|
@@ -148,11 +145,12 @@ S_HTML">
|
|
|
148
145
|
|
|
149
146
|
</div>
|
|
150
147
|
|
|
151
|
-
|
|
152
|
-
Generated on
|
|
148
|
+
<div id="footer">
|
|
149
|
+
Generated on Wed Aug 17 18:27:25 2016 by
|
|
153
150
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
154
|
-
0.
|
|
151
|
+
0.9.5 (ruby-2.2.2).
|
|
155
152
|
</div>
|
|
156
153
|
|
|
154
|
+
</div>
|
|
157
155
|
</body>
|
|
158
156
|
</html>
|
|
Binary file
|
|
Binary file
|
|
@@ -1,9 +1,18 @@
|
|
|
1
1
|
! MathJaxYard
|
|
2
2
|
|
|
3
3
|
mathjax-yardはyardによるmarkdown変換においてmathjaxを使えるようにする拡張機能です．
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
|
|
5
|
+
Github, rubygemsなど，この文書をどのサイトで見るかによって見え方が変わります．
|
|
6
|
+
|
|
7
|
+
*[[yardの出力見本|http://nishitani0.kwansei.ac.jp/Open/mathjax-yard/]]
|
|
8
|
+
|
|
9
|
+
が，mathjax-yardで意図している完成形です．そこから数式サンプルをたどってみてください．綺麗に数式が表示されるはず．
|
|
10
|
+
|
|
11
|
+
||項目|| from gems || for github
|
|
12
|
+
||なぜ開発したか||[[gems|file.Why_mathjax-yard.mjx.html]]||[[wiki|Why_mathjax-yard]]
|
|
13
|
+
||数式サンプル1||[[gems|file.atom.mjx.html]]||[[gems|atom]]
|
|
14
|
+
||数式サンプル2||[[gems|file.potential.mjx.html]]||[[gems|potential]]
|
|
15
|
+
|
|
7
16
|
|
|
8
17
|
!! Installation
|
|
9
18
|
|
|
@@ -12,7 +21,13 @@ Add this line to your application's Gemfile:
|
|
|
12
21
|
<<<ruby
|
|
13
22
|
gem 'mathjax-yard'
|
|
14
23
|
>>>
|
|
15
|
-
|
|
24
|
+
or
|
|
25
|
+
<<<ruby
|
|
26
|
+
Gem::Specification.new do |spec|
|
|
27
|
+
...
|
|
28
|
+
spec.add_development_dependency "mathjax-yard", "~> 1.0.2"
|
|
29
|
+
end
|
|
30
|
+
>>>
|
|
16
31
|
And then execute:
|
|
17
32
|
|
|
18
33
|
$ bundle
|
|
@@ -22,8 +37,52 @@ Or install it yourself as:
|
|
|
22
37
|
$ gem install mathjax-yard
|
|
23
38
|
|
|
24
39
|
!! Usage
|
|
40
|
+
mathjax-yardは，bundle gemで作られるgemの開発directoryでの文書作成を前提に作られています．
|
|
41
|
+
|
|
42
|
+
!!!準備
|
|
43
|
+
yardのoptionは，.yardoptsに
|
|
25
44
|
|
|
26
|
-
|
|
45
|
+
<<<
|
|
46
|
+
-t mathjax -p templates
|
|
47
|
+
-
|
|
48
|
+
spec/*.md
|
|
49
|
+
>>>
|
|
50
|
+
|
|
51
|
+
としています．
|
|
52
|
+
|
|
53
|
+
htmlのhead部分にmathjaxのscriptを埋め込んだlayoutを用意する必要があります．
|
|
54
|
+
mathjax-yardでは，
|
|
55
|
+
<<<csh
|
|
56
|
+
mathjax-yard --init
|
|
57
|
+
>>>
|
|
58
|
+
で自動生成します．
|
|
59
|
+
|
|
60
|
+
その他に，Rakefile, .yardoptsに記述の追加が必要ですが，今は手動で行うように指示しています．
|
|
61
|
+
|
|
62
|
+
!!Usage
|
|
63
|
+
<<<csh
|
|
64
|
+
Usage: mathjax-yard [options] [DIRECTORY]
|
|
65
|
+
with no extention: mathjax-yard -p lib/../*/*.md
|
|
66
|
+
|
|
67
|
+
-v, --version show program Version.
|
|
68
|
+
-r, --revert revert mjx file to orig file.
|
|
69
|
+
-p, --pre pre operation.
|
|
70
|
+
--post post operation.
|
|
71
|
+
-i, --init init for mathjax on yard layout.
|
|
72
|
+
>>>
|
|
73
|
+
|
|
74
|
+
yardのデフォルトでの動作をなぞって，動作するように作られています．
|
|
75
|
+
* mathjax-yardは./*/*.mdを探索し，それらの中に'\$\$'あるいは'\$\$..\$\$'があると\$MATHJAX20\$などというタグに付け替え，
|
|
76
|
+
* *.mjx.mdとしたファイルに元ファイルのバックアップを取り，タグ付け替えした内容を保存します．
|
|
77
|
+
*また，同時に，'mathjax.yml'にそれらのhash関係をyaml形式で保存します．
|
|
78
|
+
* 通常のrake yardで変換したのち，
|
|
79
|
+
* 'mathjax-yard --post'によって，'doc/file.*.mjx.html'に残されたtagを元に戻します．
|
|
80
|
+
* また同時に，mjx.mdファイルを消します．
|
|
81
|
+
* doc中には，files.*.mjx.htmlとfiles.*.htmlという2種類のほぼ同じ内容のhtmlが生成されます．
|
|
82
|
+
|
|
83
|
+
!!!Rakefileでの使用例
|
|
84
|
+
|
|
85
|
+
Rakefileでの使用例は次の通りです．
|
|
27
86
|
|
|
28
87
|
<<< ruby
|
|
29
88
|
desc "make documents by yard"
|
|
@@ -42,38 +101,6 @@ task :myard => [:pre_math,:yard] do
|
|
|
42
101
|
end
|
|
43
102
|
>>>
|
|
44
103
|
|
|
45
|
-
yardのデフォルトでの動作をなぞって，動作するように作られています．
|
|
46
|
-
* mathjax-yardは./*/*.mdを探索し，それらの中に'\$\$'あるいは'\$\$..\$\$'があると\$MATHJAX20\$などというタグに付け替え，
|
|
47
|
-
* *.mj.mdとしたファイルに元ファイルのバックアップを取り，*.mdにタグ付け替えした内容を保存します．
|
|
48
|
-
*また，同時に， 'mathjax.yml'にそれらのhash関係をyaml形式で保存します．
|
|
49
|
-
* 通常のrake yardで変換したのち，
|
|
50
|
-
* 'mathjax-yard --post'によって，'doc/file.*.mjx.html'に残されたtagを元に戻します．
|
|
51
|
-
* また同時に，mjx.mdファイルを消します．
|
|
52
|
-
|
|
53
|
-
yardのoptionは，.yardoptsに
|
|
54
|
-
|
|
55
|
-
<<<
|
|
56
|
-
-t mathjax -p templates
|
|
57
|
-
-
|
|
58
|
-
spec/*.md
|
|
59
|
-
>>>
|
|
60
|
-
|
|
61
|
-
としています．また，htmlのhead部分にmathjaxのscriptを埋め込んだlayoutを用意しています．
|
|
62
|
-
|
|
63
|
-
これをmathjax-yardで行うには，
|
|
64
|
-
<<<csh
|
|
65
|
-
mathjax-yard --init
|
|
66
|
-
>>>
|
|
67
|
-
とする必要があります．
|
|
68
|
-
|
|
69
|
-
<<<csh
|
|
70
|
-
bob% mathjax-yard --help
|
|
71
|
-
Usage: yardmath [options] [DIRECTORY]
|
|
72
|
-
-v, --version show program Version.
|
|
73
|
-
-r, --revert revert mjx file to orig file.
|
|
74
|
-
-p, --post post operation.
|
|
75
|
-
-i, --init initiation for mathjax extension on yard layout.
|
|
76
|
-
>>>
|
|
77
104
|
|
|
78
105
|
!! Development
|
|
79
106
|
|
|
@@ -81,6 +108,9 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
|
|
|
81
108
|
|
|
82
109
|
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [[rubygems.org|https://rubygems.org]].
|
|
83
110
|
|
|
111
|
+
!!left issues
|
|
112
|
+
*[[残された課題|file.Why_mathjax-yard.html]]のやり残しに既述．
|
|
113
|
+
|
|
84
114
|
!! Contributing
|
|
85
115
|
|
|
86
116
|
Bug reports and pull requests are welcome on GitHub at [[https://github.com/[USERNAME]/mathjax-yard]]. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [[Contributor Covenant|http://contributor-covenant.org]] code of conduct.
|
|
@@ -89,3 +119,4 @@ Bug reports and pull requests are welcome on GitHub at [[https://github.com/[USE
|
|
|
89
119
|
!! License
|
|
90
120
|
|
|
91
121
|
The gem is available as open source under the terms of the [[MIT License|http://opensource.org/licenses/MIT]].
|
|
122
|
+
|