IgapyonMd2Html.html

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja"><head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="IgapyonMd2Html is a command line utility which convert Markdown text (*.md) to Html text with Bootstrap (*.html). ">
<meta name="author" content="Toshiki Iga">
<meta name="generator" content="Igapyon Diary System v3 (igapyonv3) ver010">
<title>IgapyonMd2Html</title>
<!-- Compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
</head>
<body>
<div class="container-fluid">
<div class="jumbotron">
<h1><a href="#igapyonmd2html" name="igapyonmd2html">IgapyonMd2Html</a></h1><p><a href="https://github.com/igapyon/igapyonv3/blob/master/IgapyonMd2Html.md">IgapyonMd2Html</a> is a command line utility which convert Markdown text (*.md) to Html text with Bootstrap (*.html). </p></div>
<div class="container-fluid">
<h2 class="alert alert-warning"><a href="#basic-info" name="basic-info">Basic info</a></h2>
<ul>
  <li>Homepage: <a href="https://github.com/igapyon/igapyonv3/blob/master/IgapyonMd2Html.md">https://github.com/igapyon/igapyonv3/blob/master/IgapyonMd2Html.md</a></li>
</ul><h3 class="bg-success"><a href="#license" name="license">License</a></h3><p>IgapyonMd2Html is released under GNU LGPL version 3 and Apache License version 2 (dual license). You can select either LGPL or ASL or both. </p><h3 class="bg-success"><a href="#simple-sample" name="simple-sample">Simple sample</a></h3><p>IgapyonMd2Html convert like below:</p>
<table class="table table-bordered">
  <thead>
    <tr>
      <th>Convert</th>
      <th>Image</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Input </td>
      <td><a href="https://raw.githubusercontent.com/igapyon/igapyonv3/master/README.md"><img src="https://raw.githubusercontent.com/igapyon/igapyonv3/master/doc/image/IgapyonMd2Html-input.png" alt="IgapyonMd2Html-input.png" /></a></td>
    </tr>
    <tr>
      <td>Output </td>
      <td><a href="https://raw.githubusercontent.com/igapyon/igapyonv3/master/README.html"><img src="https://raw.githubusercontent.com/igapyon/igapyonv3/master/doc/image/IgapyonMd2Html-output.png" alt="IgapyonMd2Html-output.png" /></a></td>
    </tr>
  </tbody>
</table><h3 class="bg-success"><a href="#parts" name="parts">Parts</a></h3>
<ul>
  <li>Hashtag: #‎igapyonv3‬</li>
  <li>Data format: ‪#‎Markdown</li>
  <li>Web design: ‪#‎Bootstrap‬</li>
  <li>Written in #‎Java</li>
</ul><h3 class="bg-success"><a href="#depends" name="depends">Depends</a></h3><p>IgapyonMd2Html depends on several great OSSs. Great thanks to great OSSs.</p>
<ul>
  <li><a href="https://github.com/sirthias/pegdown">pegdown</a></li>
  <li><a href="https://github.com/sirthias/parboiled">parboiled</a></li>
  <li><a href="http://asm.ow2.org/">ASM</a></li>
  <li><a href="http://getbootstrap.com/">Bootstrap</a></li>
  <li><a href="https://jquery.com/">jQuery</a></li>
  <li><a href="http://ant.apache.org/">Apache Ant</a></li>
  <li><a href="https://commons.apache.org/proper/commons-cli/">Apache Commons CLI</a></li>
  <li><a href="https://commons.apache.org/proper/commons-io/">Apache Commons IO</a></li>
</ul><h2 class="alert alert-warning"><a href="#project-info" name="project-info">Project info</a></h2><h3 class="bg-success"><a href="#main-project" name="main-project">Main project</a></h3>
<ul>
  <li><a href="https://github.com/igapyon/igapyonv3/blob/master/README.md">igapyonv3</a></li>
</ul><h3 class="bg-success"><a href="#similar-project" name="similar-project">Similar project</a></h3>
<ul>
  <li><a href="https://maven.apache.org/doxia/">Apache Doxia</a> : Doxia is full featured conveter. IgapyonMd2Html is focused in for Dairy.</li>
</ul><h2 class="alert alert-warning"><a href="#usage" name="usage">Usage</a></h2><h3 class="bg-success"><a href="#java-usage" name="java-usage">Java usage</a></h3>
<pre><code class="Java">    new IgapyonMd2Html().processDir(&quot;./&quot;, &quot;./&quot;, false);
</code></pre><h3 class="bg-success"><a href="#ant-usage" name="ant-usage">ant usage</a></h3><p>Ant usage is below:</p>
<pre><code class="xml">	&lt;target name=&quot;md2html&quot;&gt;
		&lt;echo&gt;run project&lt;/echo&gt;
		&lt;taskdef name=&quot;md2html&quot; classname=&quot;jp.igapyon.diary.v3.md2html.task.IgapyonMd2HtmlTask&quot;&gt;
			&lt;classpath&gt;
				&lt;fileset dir=&quot;./&quot;&gt;
					&lt;include name=&quot;igapyonv3-*.jar&quot; /&gt;
				&lt;/fileset&gt;
				&lt;fileset dir=&quot;./lib/pegdown&quot;&gt;
					&lt;include name=&quot;*.jar&quot; /&gt;
				&lt;/fileset&gt;
				&lt;fileset dir=&quot;./lib/ant&quot;&gt;
					&lt;include name=&quot;*.jar&quot; /&gt;
				&lt;/fileset&gt;
			&lt;/classpath&gt;
		&lt;/taskdef&gt;
		&lt;md2html source=&quot;./&quot; target=&quot;./&quot; /&gt;
		&lt;md2html source=&quot;./test/data/src&quot; target=&quot;./test/data/output&quot; recursivedir=&quot;true&quot; /&gt;
	&lt;/target&gt;
</code></pre><h3 class="bg-success"><a href="#refs" name="refs">Refs</a></h3>
<ul>
  <li><a href="http://getbootstrap.com/components/">Bootstrap Components</a></li>
</ul><h3 class="bg-success"><a href="#todo" name="todo">TODO</a></h3>
<ul>
  <li>Up to website to display what this product enable.</li>
  <li>img tag for Face.</li>
  <li>consider keyword impl.</li>
  <li>Return to index link.</li>
  <li>adv area.</li>
  <li>is date area is from filename?</li>
  <li>tail format for About igapyon.</li>
  <li>tail format for last modified (or other impl like metaarea)</li>
  <li>Next and Prev like igapyonv2. based on idxdiary?</li>
  <li>Consider CDN off mode. for offline.</li>
  <li>Supporting without CDN needs to analyze deapth of dir.</li>
</ul><h3 class="bg-success"><a href="#trash-memo" name="trash-memo">Trash memo</a></h3>
<ul>
  <li>using glyphicon as h* is not so good.</li>
</ul><h1 class="alert alert-danger"><a href="#meta-inf" name="meta-inf">META-INF</a></h1><p><code>META-INF</code> is reserved word in IgapyonMd2Html on &lt;h1&gt;, and is used in &lt;meta keywords&gt; and will be discard in html.</p><h2 class="alert alert-warning"><a href="#date" name="date">Date</a></h2><p>First one is used in html.</p>
<ul>
  <li>2015-07-24: Small change.</li>
  <li>2015-07-23: Newly created.</li>
</ul><h2 class="alert alert-warning"><a href="#author" name="author">Author</a></h2>
<ul>
  <li>Toshiki Iga</li>
</ul><h2 class="alert alert-warning"><a href="#keywords" name="keywords">Keywords</a></h2><p>Keywords list description. You can use , or - or both.</p>
<ul>
  <li>Igapyon, diary</li>
  <li>Bootstrap, Markdown</li>
</ul><h2 class="alert alert-warning"><a href="#todo" name="todo">Todo</a></h2>
<ul>
  <li>Consider new word to describe md's relative location.</li>
</ul>
</div><!-- container-fluid -->
<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
<!-- Compiled and minified JavaScript -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
</body>
</html>