mathjax-yard 1.0.1 → 1.0.2

data/doc/_index.html

@@ -82,15 +82,27 @@
     <li class="r2"><a href="file.atom.html" title="atom">atom</a></li>
     
   
-    <li class="r1"><a href="file.Home.html" title="Home">Home</a></li>
+    <li class="r1"><a href="file.atom.mjx.html" title="atom.mjx">atom.mjx</a></li>
     
   
-    <li class="r2"><a href="file.potential2.html" title="potential2">potential2</a></li>
+    <li class="r2"><a href="file.Home.html" title="Home">Home</a></li>
+    
+  
+    <li class="r1"><a href="file.potential.html" title="potential">potential</a></li>
+    
+  
+    <li class="r2"><a href="file.potential.mjx.html" title="potential.mjx">potential.mjx</a></li>
     
   
     <li class="r1"><a href="file.README_ja.html" title="README_ja">README_ja</a></li>
     
   
+    <li class="r2"><a href="file.Why_mathjax-yard.html" title="Why_mathjax-yard">Why_mathjax-yard</a></li>
+    
+  
+    <li class="r1"><a href="file.Why_mathjax-yard.mjx.html" title="Why_mathjax-yard.mjx">Why_mathjax-yard.mjx</a></li>
+    
+  
   </ul>
 
 <div class="clear"></div>
@@ -140,7 +152,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Jun 23 14:03:52 2016 by
+  Generated on Fri Jun 24 11:52:33 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>

data/doc/file.Home.html

@@ -73,11 +73,105 @@
 
     <iframe id="search_frame"></iframe>
 
-    <div id="content"><div id='filecontents'><p>Welcome to the mathjax-yard wiki!</p>
+    <div id="content"><div id='filecontents'><h1>MathJaxYard</h1>
+
+<p>mathjax-yardはyardによるmarkdown変換においてmathjaxを使えるようにする拡張機能です．</p>
+
+<ul>
+<li><a href="file.Why_mathjax-yard.mjx.html">なぜ開発したか</a></li>
+<li><a href="file.atom.mjx.html">数式サンプル1</a></li>
+<li><a href="file.potential.mjx.html">数式サンプル2</a></li>
+</ul>
+
+<h2>Installation</h2>
+
+<p>Add this line to your application&#39;s Gemfile:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>&#39;</span></span>
+</code></pre>
+
+<p>And then execute:</p>
+
+<pre class="code ruby"><code class="ruby">$ bundle
+</code></pre>
+
+<p>Or install it yourself as:</p>
+
+<pre class="code ruby"><code class="ruby">$ gem install mathjax-yard
+</code></pre>
+
+<h2>Usage</h2>
+
+<p>mathjax-yardはcommand line toolとしての使用を意図して作られています．例えば，Rakefileでの使用例は次の通りです．</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>make documents by yard</span><span class='tstring_end'>&quot;</span></span>
+<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:yard</span> <span class='kw'>do</span>
+  <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>
+<span class='kw'>end</span>
+
+<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>arrange yard target by mathjax-yard</span><span class='tstring_end'>&quot;</span></span>
+<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:pre_math</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='kw'>end</span>
+
+<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>make yard documents with yardmath</span><span class='tstring_end'>&quot;</span></span>
+<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:myard</span> <span class='op'>=&gt;</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>
+  <span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mathjax-yard --post</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='kw'>end</span>
+</code></pre>
+
+<p>yardのデフォルトでの動作をなぞって，動作するように作られています．</p>
+
+<ul>
+<li>mathjax-yardは./<em>/</em>.mdを探索し，それらの中に&#39;\$\$&#39;あるいは&#39;\$\$..\$\$&#39;があると\$MATHJAX20\$などというタグに付け替え，</li>
+<li><em>.mj.mdとしたファイルに元ファイルのバックアップを取り，</em>.mdにタグ付け替えした内容を保存します．</li>
+<li>また，同時に，  &#39;mathjax.yml&#39;にそれらのhash関係をyaml形式で保存します．</li>
+<li>通常のrake yardで変換したのち，</li>
+<li>&#39;mathjax-yard --post&#39;によって，&#39;doc/file.*.mjx.html&#39;に残されたtagを元に戻します．</li>
+<li>また同時に，mjx.mdファイルを消します．</li>
+</ul>
+
+<p>yardのoptionは，.yardoptsに</p>
+
+<pre class="code ruby"><code class="ruby">-t mathjax -p templates
+-
+spec/*.md
+</code></pre>
+
+<p>としています．また，htmlのhead部分にmathjaxのscriptを埋め込んだlayoutを用意しています．</p>
+
+<p>これをmathjax-yardで行うには，</p>
+
+<pre class="code csh"><code class="csh"> mathjax-yard --init
+</code></pre>
+
+<p>とする必要があります．</p>
+
+<pre class="code csh"><code class="csh">bob% mathjax-yard --help
+Usage: yardmath [options] [DIRECTORY]
+    -v, --version                    show program Version.
+    -r, --revert                     revert mjx file to orig file.
+    -p, --post                       post operation.
+    -i, --init                       initiation for mathjax extension on yard layout.
+</code></pre>
+
+<h2>Development</h2>
+
+<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake spec</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment. Run <code>bundle exec mathjax-yard</code> to use the gem in this directory, ignoring other installed copies of this gem.</p>
+
+<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>
+
+<h2>Contributing</h2>
+
+<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>
+
+<h2>License</h2>
+
+<p>The gem is available as open source under the terms of the <a href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Thu Jun 23 14:03:52 2016 by
+  Generated on Fri Jun 24 11:52:33 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>

data/doc/file.README.html

@@ -75,7 +75,13 @@
 
     <div id="content"><div id='filecontents'><h1>MathJaxYard</h1>
 
-<p>mathjax-yard is a mathjax extension for markdown in yard.</p>
+<p>mathjax-yardはyardによるmarkdown変換においてmathjaxを使えるようにする拡張機能です．</p>
+
+<ul>
+<li><a href="file.Why_mathjax-yard.mjx.html">なぜ開発したか</a></li>
+<li><a href="file.atom.mjx.html">数式サンプル1</a></li>
+<li><a href="file.potential.mjx.html">数式サンプル2</a></li>
+</ul>
 
 <h2>Installation</h2>
 
@@ -96,28 +102,58 @@
 
 <h2>Usage</h2>
 
-<p>mathjax-yard is intended to be a command line tool, using in Rakefile as follows.</p>
+<p>mathjax-yardはcommand line toolとしての使用を意図して作られています．例えば，Rakefileでの使用例は次の通りです．</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>make documents by yard</span><span class='tstring_end'>&quot;</span></span>
 <span class='id identifier rubyid_task'>task</span> <span class='symbol'>:yard</span> <span class='kw'>do</span>
-  <span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
   <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>
 <span class='kw'>end</span>
 
-<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>make documents with yardmath</span><span class='tstring_end'>&quot;</span></span>
-<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:mathjax</span> <span class='kw'>do</span>
+<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>arrange yard target by mathjax-yard</span><span class='tstring_end'>&quot;</span></span>
+<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:pre_math</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='kw'>end</span>
+
+<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>make yard documents with yardmath</span><span class='tstring_end'>&quot;</span></span>
+<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:myard</span> <span class='op'>=&gt;</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>
   <span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mathjax-yard --post</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 <span class='kw'>end</span>
 </code></pre>
 
-<p>mathjax-yard search ./<em>/</em>.md and replace &#39;$...$&#39; or &#39;$$...$$&#39; to $MATHJAX*<em>$ tags, and make &#39;mathjax.yml&#39; for storing these relations.  After the normal YARD operation has done, &#39;mathjax-yard --post&#39; replacement will be done on &#39;doc/file.</em>.html&#39;.  The yard options are</p>
+<p>yardのデフォルトでの動作をなぞって，動作するように作られています．</p>
+
+<ul>
+<li>mathjax-yardは./<em>/</em>.mdを探索し，それらの中に&#39;\$\$&#39;あるいは&#39;\$\$..\$\$&#39;があると\$MATHJAX20\$などというタグに付け替え，</li>
+<li><em>.mj.mdとしたファイルに元ファイルのバックアップを取り，</em>.mdにタグ付け替えした内容を保存します．</li>
+<li>また，同時に，  &#39;mathjax.yml&#39;にそれらのhash関係をyaml形式で保存します．</li>
+<li>通常のrake yardで変換したのち，</li>
+<li>&#39;mathjax-yard --post&#39;によって，&#39;doc/file.*.mjx.html&#39;に残されたtagを元に戻します．</li>
+<li>また同時に，mjx.mdファイルを消します．</li>
+</ul>
+
+<p>yardのoptionは，.yardoptsに</p>
 
 <pre class="code ruby"><code class="ruby">-t mathjax -p templates
 -
 spec/*.md
 </code></pre>
 
-<p>The mathjax layout should be included in yard layout.</p>
+<p>としています．また，htmlのhead部分にmathjaxのscriptを埋め込んだlayoutを用意しています．</p>
+
+<p>これをmathjax-yardで行うには，</p>
+
+<pre class="code csh"><code class="csh"> mathjax-yard --init
+</code></pre>
+
+<p>とする必要があります．</p>
+
+<pre class="code csh"><code class="csh">bob% mathjax-yard --help
+Usage: yardmath [options] [DIRECTORY]
+    -v, --version                    show program Version.
+    -r, --revert                     revert mjx file to orig file.
+    -p, --post                       post operation.
+    -i, --init                       initiation for mathjax extension on yard layout.
+</code></pre>
 
 <h2>Development</h2>
 
@@ -127,7 +163,7 @@ spec/*.md
 
 <h2>Contributing</h2>
 
-<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/%5BUSERNAME%5D/mathjax-yard">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>
+<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>
 
 <h2>License</h2>
 
@@ -135,7 +171,7 @@ spec/*.md
 </div></div>
 
     <div id="footer">
-  Generated on Thu Jun 23 14:03:52 2016 by
+  Generated on Fri Jun 24 11:52:33 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>

data/doc/file.README_ja.html

@@ -77,6 +77,12 @@
 
 <p>mathjax-yardはyardによるmarkdown変換においてmathjaxを使えるようにする拡張機能です．</p>
 
+<ul>
+<li><a href="file.Why_mathjax-yard.mjx.html">なぜ開発したか</a></li>
+<li><a href="file.atom.mjx.html">数式サンプル1</a></li>
+<li><a href="file.potential.mjx.html">数式サンプル2</a></li>
+</ul>
+
 <h2>Installation</h2>
 
 <p>Add this line to your application&#39;s Gemfile:</p>
@@ -100,12 +106,16 @@
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>make documents by yard</span><span class='tstring_end'>&quot;</span></span>
 <span class='id identifier rubyid_task'>task</span> <span class='symbol'>:yard</span> <span class='kw'>do</span>
-  <span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
   <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>
 <span class='kw'>end</span>
 
-<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>make documents with yardmath</span><span class='tstring_end'>&quot;</span></span>
-<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:mathjax</span> <span class='kw'>do</span>
+<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>arrange yard target by mathjax-yard</span><span class='tstring_end'>&quot;</span></span>
+<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:pre_math</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mathjax-yard</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='kw'>end</span>
+
+<span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>make yard documents with yardmath</span><span class='tstring_end'>&quot;</span></span>
+<span class='id identifier rubyid_task'>task</span> <span class='symbol'>:myard</span> <span class='op'>=&gt;</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>
   <span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mathjax-yard --post</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 <span class='kw'>end</span>
 </code></pre>
@@ -114,11 +124,11 @@
 
 <ul>
 <li>mathjax-yardは./<em>/</em>.mdを探索し，それらの中に&#39;\$\$&#39;あるいは&#39;\$\$..\$\$&#39;があると\$MATHJAX20\$などというタグに付け替え，</li>
-<li><em>.md.backとしたファイルに元ファイルのバックアップを取り，</em>.mdにタグ付け替えした内容を保存します．
-*また，同時に，  &#39;mathjax.yml&#39;にそれらのhash関係をyaml形式で保存します．</li>
+<li><em>.mj.mdとしたファイルに元ファイルのバックアップを取り，</em>.mdにタグ付け替えした内容を保存します．</li>
+<li>また，同時に，  &#39;mathjax.yml&#39;にそれらのhash関係をyaml形式で保存します．</li>
 <li>通常のrake yardで変換したのち，</li>
-<li>&#39;mathjax-yard --post&#39;によって，&#39;doc/file.*.html&#39;に残されたtagを元に戻します．</li>
-<li>また同時に，backファイルを元に戻します．</li>
+<li>&#39;mathjax-yard --post&#39;によって，&#39;doc/file.*.mjx.html&#39;に残されたtagを元に戻します．</li>
+<li>また同時に，mjx.mdファイルを消します．</li>
 </ul>
 
 <p>yardのoptionは，.yardoptsに</p>
@@ -130,11 +140,19 @@ spec/*.md
 
 <p>としています．また，htmlのhead部分にmathjaxのscriptを埋め込んだlayoutを用意しています．</p>
 
-<pre class="code csh"><code class="csh">bob% bundle exec exe/mathjax-yard --help
+<p>これをmathjax-yardで行うには，</p>
+
+<pre class="code csh"><code class="csh"> mathjax-yard --init
+</code></pre>
+
+<p>とする必要があります．</p>
+
+<pre class="code csh"><code class="csh">bob% mathjax-yard --help
 Usage: yardmath [options] [DIRECTORY]
     -v, --version                    show program Version.
     -r, --revert                     revert mjx file to orig file.
     -p, --post                       post operation.
+    -i, --init                       initiation for mathjax extension on yard layout.
 </code></pre>
 
 <h2>Development</h2>
@@ -145,7 +163,7 @@ Usage: yardmath [options] [DIRECTORY]
 
 <h2>Contributing</h2>
 
-<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/%5BUSERNAME%5D/mathjax-yard">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>
+<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>
 
 <h2>License</h2>
 
@@ -153,7 +171,7 @@ Usage: yardmath [options] [DIRECTORY]
 </div></div>
 
     <div id="footer">
-  Generated on Thu Jun 23 14:03:52 2016 by
+  Generated on Fri Jun 24 11:52:33 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>

data/doc/file.Why_mathjax-yard.html

@@ -0,0 +1,176 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <script type="text/x-mathjax-config">
+      MathJax.Hub.Config({
+                           tex2jax:{
+      inlineMath: [ ['$','$'], ["\(","\)"] ],
+      displayMath: [ ['$$','$$'], ["\[","\]"] ]
+                           }
+                         });
+    </script>
+    <script type="text/javascript"
+            src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML">
+    </script>
+    <meta http-equiv="X-UA-Compatible" CONTENT="IE=EmulateIE7" />
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>
+  File: Why_mathjax-yard
+  
+    &mdash; Documentation by YARD 0.8.7.6
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!file.Why_mathjax-yard.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index</a> &raquo; 
+    <span class="title">File: Why_mathjax-yard</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><div id='filecontents'><h1>導入の経緯</h1>
+
+<h2>概要</h2>
+
+<p>mathjaxとmark downの周辺状況から，なぜmathjax-yardが必要になったかをまとめておきます．</p>
+
+<h2>状況</h2>
+
+<p>数値計算や物理シミュレーションにおいては，解説に数式が不可欠です．
+記法としては$LaTeX$形式がありますが，これをhtmlで表示するには工夫が必要です．
+gemなどを作るとき，yardでdocumentationを自動化することが可能です．
+しかし，そこに数式を組み込んでも，うまく表示されません．</p>
+
+<h3>MathML or mathjax</h3>
+
+<table><thead>
+<tr>
+<th style="text-align: left">MathML</th>
+<th style="text-align: left">mathjax</th>
+</tr>
+</thead><tbody>
+<tr>
+<td style="text-align: left">firefoxのみ</td>
+<td style="text-align: left">なんでも</td>
+</tr>
+</tbody></table>
+
+<h2>mark down with mathjax extension</h2>
+
+<ul>
+<li>Githubのwikiはmark down 記法を取っているが，math拡張が切られた．</li>
+<li>Qiitaなどは独自拡張しているが，ない．</li>
+<li>yard
+
+<ul>
+<li>mathjaxの拡張ができる</li>
+<li>optionsに，組み込まれてはいない．</li>
+</ul></li>
+<li>atom
+
+<ul>
+<li>mathjax-wrapper とmarkdown_preview_plusでlive変換・表示できる．</li>
+<li>htmlへの変換はあるが，あまりきれいでない．</li>
+</ul></li>
+<li>pandoc
+
+<ul>
+<li>mathjaxを組み込んでhtmlに変換できる</li>
+<li>cssなどに汎用性がなく，体裁をいじるのは難しい．</li>
+</ul></li>
+</ul>
+
+<h2>つまり</h2>
+
+<p>個別にmathjaxの入ったmd文書をhtmlに変換することができたとしても，
+yardで自動生成される体裁の整った文書としては得ることが難しいというのが現状です．</p>
+
+<h2>解決法</h2>
+
+<p>そこで，yardのpre, postコマンドとして動作するmathjax-yardを開発しました．</p>
+
+<ul>
+<li>yardで変換される，<em>/</em>.md中の数式をMATHJAXタグに付け替え．</li>
+<li>yardでmd-&gt;html変換</li>
+<li>できたdoc/file.*.htmlのMATHJAXタグを数式に戻す
+という操作をしています．</li>
+</ul>
+
+<h2>やり残し</h2>
+
+<ul>
+<li>default動作以外のyard変換への対応
+
+<ul>
+<li>特に*.rbへの対応</li>
+</ul></li>
+<li>hikiへの対応</li>
+<li>yardへのpull request</li>
+<li>$を記述しようとしてもだめ．
+
+<ul>
+<li>\$で逃げている(16/6/23対応断念)．</li>
+</ul></li>
+<li>最小一致を使った記述の単純化(16/6/23対応)．</li>
+<li>Rakefileでのコマンド一発での変換
+
+<ul>
+<li>一つ所に書くと，systemコマンドなどがmultitaskで走ってしまう．</li>
+<li>taskを分割してそれぞれを終了させた(16/6/23対応)．</li>
+</ul></li>
+</ul>
+</div></div>
+
+    <div id="footer">
+  Generated on Fri Jun 24 11:52:33 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.2.2).
+</div>
+
+  </body>
+</html>