docs/index.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<link rel="stylesheet" href="late17.css">
<meta name="description" content="use devist to keep changelog file clean
and properly formatted" />
<meta name="viewport" content="width=device-width" />
<link href="https://fonts.googleapis.com/css?family=EB+Garamond"
rel="stylesheet">
<title>Devist - Keep your changelog clean.</title>
</head>
<html>
<div class="container">
<p class="title">Proper changelog or we will kick your ass.</p>
<code class="code-gem-install"> gem install devist </code>
<!-- what's the fuss -->
<div class="container-section">
<p class="title-other">What's the fuss?</p>
<div class="container-block-section">
<p class="container-block-text">
Changelog files are useful. You can `cat` it out
and see latest or whatever change in the past? Grep version? It’s
like a textual versioning system or something.
<br><br>
<b>Devist</b> keeps proper changelog for any of your projects.
</p>
</div>
</div>
<!-- what it offers -->
<div class="container-section">
<p class="title-other">What it offers?</p>
<div class="container-block-section">
<p class="container-block-text">
Just some of the stuff that Devist offers out of the box:
<br>
<ul>
<li>Export w/ themes</li>
<li>Manipulate raw</li>
<li>Readable format</li>
</ul>
<ul>
<li>Deployment hook</li>
<li>Git hook</li>
<li>API</li>
</ul>
</p>
</div>
</div>
<!-- how to use it -->
<div class="container-section">
<p class="title-other">How to use it?</p>
<div class="container-block-section">
<p class="container-block-text">
Simple as 1, 2, 3. Write your project changelog in `devist` format:
<br>
</p>
</div>
<div class="container-block-code">
<p class="container-block-code-text">### Version 1.0.0 of Aug 15
2017<br>
+ #added: some feature here<br>
+ #fixed: some bug that now is past<br><br>
# or run devist --new to init new changelog file</p>
</div>
<div class="container-block-section">
<p class="container-block-text">
Run Devist from same directory to generate static html:
<br>
</p>
</div>
<code class="code-gem-install"> devist changelog </code>
<div class="container-block-section">
<p class="container-block-text">
Generated results as seen on <a href="changelog.html">release
notes</a>.
<br>
</p>
</div>
<div class="container-block-section" style="margin-top: 30px;">
<p class="container-block-text">
Use help argument to see all available cli commands:
<br>
</p>
</div>
<code class="code-gem-install"> devist --help </code>
</div>
<!-- more info -->
<div class="container-section">
<p class="title-other">More info</p>
<div class="container-block-section">
<p class="container-block-text">
Devist is open-source and official repository is located at
<a href="https://github.com/duraki/devist">duraki/devist</a>.
You can also read full documentation in the repo README.
<br><br>
API is documented using YARD and is available at <a
href="http://rubydoc.info/gems/devist/">Rubydoc</a>.
</p>
</div>
</div>
<!-- credits section -->
<div class="container-section">
<p class="title-other">Author & Credits</p>
<div class="container-block-section">
<p class="container-block-text">
The tool and website is developed and designed by Halis Duraki
(@duraki). You can write issues or request a feature if that
will help you keep better changelog. Props to people who support
me.<br><br>
My <a href="https://twitter.com/devil_tux">twitter</a>, <a
href="https://github.com/duraki">github</a> and <a
href="https://duraki.github.io">blog</a>.
</p>
</div>
</div>
</div>
</html>