update docs site
This commit is contained in:
Kevin Schoon
parent
b2fc750ed3
commit
1b2d22aa5a
|
|
@ -1,14 +1,10 @@
|
|||
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>Categories on Pomo</title>
|
||||
<link>/pomo/categories/</link>
|
||||
<description>Recent content in Categories on Pomo</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-us</language>
|
||||
|
||||
<atom:link href="/pomo/categories/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
|
||||
<language>en-us</language><atom:link href="/pomo/categories/index.xml" rel="self" type="application/rss+xml" />
|
||||
</channel>
|
||||
</rss>
|
||||
|
|
@ -1,109 +1,83 @@
|
|||
html,
|
||||
body {
|
||||
height: 100%;
|
||||
* {
|
||||
-webkit-box-sizing: border-box;
|
||||
-moz-box-sizing: border-box;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
body {
|
||||
padding-top: 55px;
|
||||
display: flex;
|
||||
text-align: center;
|
||||
flex-direction: column;
|
||||
:root {
|
||||
--accent: #b1675d;
|
||||
--light-gray: #eee;
|
||||
--dark-gray: #c2c2c2;
|
||||
--white: #f8f9fa;
|
||||
--black: #2d2d2d;
|
||||
--border-width: 5px;
|
||||
}
|
||||
|
||||
main {
|
||||
margin: auto;
|
||||
padding: 25px;
|
||||
flex: 1 0 auto;
|
||||
max-width: 1200px;
|
||||
body {}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6,
|
||||
label {
|
||||
color: var(--black);
|
||||
}
|
||||
|
||||
/*footer*/
|
||||
|
||||
.copyright {
|
||||
margin: 15px 0;
|
||||
}
|
||||
|
||||
/*home page*/
|
||||
|
||||
/*
|
||||
.intro {
|
||||
transform: translateY(22vh);
|
||||
}
|
||||
*/
|
||||
|
||||
.intro>h1 {
|
||||
color: #212121;
|
||||
font-size: 12vh;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.intro>h2 {
|
||||
color: #757575;
|
||||
font-size: 3vmin;
|
||||
.tomato {
|
||||
max-width: 20em;
|
||||
}
|
||||
|
||||
.intro>.profile {
|
||||
width: 10vh;
|
||||
height: 10vh;
|
||||
border-radius: 50%;
|
||||
}
|
||||
|
||||
div.readme {
|
||||
text-align: left !important;
|
||||
padding-top: 50px;
|
||||
}
|
||||
|
||||
/*apply accent colour to links*/
|
||||
|
||||
a:link,
|
||||
a:visited {
|
||||
color: var(--accent);
|
||||
}
|
||||
|
||||
a.icon:hover {
|
||||
.icons a {
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: var(--accent) !important;
|
||||
.icons svg {
|
||||
margin-left: 10px;
|
||||
margin-right: 10px;
|
||||
}
|
||||
|
||||
/*paginator at bottom of list view*/
|
||||
|
||||
.pages {
|
||||
padding: 15px 0;
|
||||
.content {
|
||||
margin: auto;
|
||||
padding-top: 5em;
|
||||
}
|
||||
|
||||
.pages-icon {
|
||||
padding: 0 15px;
|
||||
.readme {
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
/*list item for posts and projects*/
|
||||
|
||||
.item {
|
||||
padding: 10px 0;
|
||||
.content h1,h2,h3,h4,h5,h6 {
|
||||
padding: .2em;
|
||||
}
|
||||
|
||||
.item-tag {
|
||||
background-color: var(--accent);
|
||||
.center-splash {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
/*navigation bar icons*/
|
||||
|
||||
.navbar-icon {
|
||||
font-size: 125%;
|
||||
display: inline-block !important;
|
||||
.splash-image img {
|
||||
border-radius: 2em;
|
||||
}
|
||||
|
||||
/*coloured borders at top and bottom of the page*/
|
||||
|
||||
.navbar.navbar-default {
|
||||
border-top: var(--border-width) solid var(--accent);
|
||||
@media screen and (max-height: 600px) {
|
||||
.center-splash {
|
||||
padding-top: 10%;
|
||||
}
|
||||
}
|
||||
|
||||
footer {
|
||||
border-bottom: var(--border-width) solid var(--accent);
|
||||
@media screen and (max-width: 900px) {
|
||||
.splash-image img {
|
||||
max-height: 250px;
|
||||
}
|
||||
}
|
||||
|
||||
img {
|
||||
max-width: 100%;
|
||||
@media screen and (min-width: 900px) {
|
||||
.content {
|
||||
max-width: 75% ;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
219
docs/index.html
219
docs/index.html
|
|
@ -1,137 +1,32 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en-us">
|
||||
<html>
|
||||
<head>
|
||||
|
||||
<meta name="generator" content="Hugo 0.85.0" />
|
||||
<meta charset="utf-8">
|
||||
<title>Pomo
|
||||
</title>
|
||||
<link rel="stylesheet" href="/css/main.css">
|
||||
<link rel="stylesheet" href="/css/pure.css">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Pomo</title>
|
||||
<style>
|
||||
|
||||
html body {
|
||||
font-family: 'Raleway', sans-serif;
|
||||
background-color: white;
|
||||
}
|
||||
|
||||
:root {
|
||||
--accent: red;
|
||||
--border-width: 5px ;
|
||||
}
|
||||
|
||||
</style>
|
||||
|
||||
|
||||
<link rel="stylesheet" href="/pomo/css/main.css">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Raleway">
|
||||
|
||||
|
||||
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/solarized-dark.min.css">
|
||||
|
||||
|
||||
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
|
||||
|
||||
|
||||
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
|
||||
|
||||
|
||||
|
||||
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
|
||||
|
||||
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/go.min.js"></script> <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/haskell.min.js"></script> <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/kotlin.min.js"></script> <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/scala.min.js"></script> <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/swift.min.js"></script>
|
||||
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
|
||||
|
||||
|
||||
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
|
||||
|
||||
|
||||
<script>$(document).on('click', function() { $('.collapse').collapse('hide'); })</script>
|
||||
<meta name="generator" content="Hugo 0.47.1" />
|
||||
|
||||
<link href="/pomo/index.xml" rel="alternate" type="application/rss+xml" title="Pomo" />
|
||||
<link href="/pomo/index.xml" rel="feed" type="application/rss+xml" title="Pomo" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<script type="text/javascript" async
|
||||
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
|
||||
</script>
|
||||
|
||||
<body>
|
||||
|
||||
<nav class="navbar navbar-default navbar-fixed-top">
|
||||
|
||||
<div class="container">
|
||||
|
||||
<div class="navbar-header">
|
||||
|
||||
<a class="navbar-brand visible-xs" href="#">Pomo</a>
|
||||
|
||||
<button class="navbar-toggle" data-target=".navbar-collapse" data-toggle="collapse">
|
||||
<span class="icon-bar"></span>
|
||||
<span class="icon-bar"></span>
|
||||
<span class="icon-bar"></span>
|
||||
</button>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="collapse navbar-collapse">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</nav>
|
||||
|
||||
<div class="content">
|
||||
|
||||
<main>
|
||||
|
||||
<div class="intro">
|
||||
|
||||
<img class="profile" src="./tomato.png">
|
||||
|
||||
<h1>Pomo</h1>
|
||||
|
||||
<h2>Pomodoro Command Line Interface</h2>
|
||||
|
||||
<div class="btn-group" role="group" aria-label="...">
|
||||
<a class="btn btn-default" href="https://github.com/kevinschoon/pomo">github</a>
|
||||
<a class="btn btn-default" href="https://github.com/kevinschoon/pomo/releases">releases</a>
|
||||
<a href="https://github.com/kevinschoon/pomo"> <img class="tomato" src="/tomato.png" /> </a>
|
||||
<h1> Pomo </h1>
|
||||
<h1> Pomodoro Command Line Interface </h1>
|
||||
<img class="demo" src="/demo.gif" />
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="readme">
|
||||
<p align="center"><img src="https://raw.githubusercontent.com/kevinschoon/pomo/master/www/static/demo.gif" alt="demo"/></p>
|
||||
|
||||
<h1 id="pomo">🍅 pomo</h1>
|
||||
|
||||
<!-- raw HTML omitted -->
|
||||
<h1 id="-pomo">🍅 pomo</h1>
|
||||
<p><img src="https://github.com/kevinschoon/pomo/workflows/pomo/badge.svg" alt="pomo"></p>
|
||||
<p><code>pomo</code> is a simple CLI for using the <a href="https://en.wikipedia.org/wiki/Pomodoro_Technique">Pomodoro Technique</a>. There are <a href="https://taskwarrior.org/">some</a> <a href="https://todoist.com/">amazing</a> task management systems but <code>pomo</code> is more of a task <em>execution</em> or <a href="https://en.wikipedia.org/wiki/Timeboxing">timeboxing</a> system. <code>pomo</code> helps you track what you did, how long it took you to do it, and how much effort you expect it to take.</p>
|
||||
|
||||
<h2 id="background">Background</h2>
|
||||
|
||||
<p>The Pomodoro Technique is simple and effective:</p>
|
||||
|
||||
<ul>
|
||||
<li>Decide on a task you want to accomplish</li>
|
||||
<li>Break the task into timed intervals (pomodoros), [approx. 25 min]</li>
|
||||
|
|
@ -139,84 +34,49 @@
|
|||
<li>Once all pomodoros are completed take a longer break [approx 15 - 20 min]</li>
|
||||
<li>Repeat</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="installation">Installation</h2>
|
||||
|
||||
<h3 id="binaries">Binaries</h3>
|
||||
|
||||
<p>Binaries are available for Linux and OSX platforms in the <a href="https://github.com/kevinschoon/pomo/releases">releases section</a> on github.</p>
|
||||
|
||||
<h3 id="installer-script">Installer Script</h3>
|
||||
|
||||
<p>A bash script to download and verify the latest release for Linux and OSX platforms can be run
|
||||
with the following command:</p>
|
||||
|
||||
<pre><code class="language-bash">curl -L -s https://kevinschoon.github.io/pomo/install.sh | bash /dev/stdin
|
||||
</code></pre>
|
||||
|
||||
<h3 id="source">Source</h3>
|
||||
|
||||
<pre><code class="language-bash"> go get github.com/kevinschoon/pomo
|
||||
pomo -v
|
||||
</code></pre>
|
||||
|
||||
<h2 id="usage">Usage</h2>
|
||||
|
||||
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">curl -L -s https://kevinschoon.github.io/pomo/install.sh | bash /dev/stdin
|
||||
</code></pre></div><h3 id="source">Source</h3>
|
||||
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">go get github.com/kevinschoon/pomo
|
||||
pomo -v
|
||||
</code></pre></div><h2 id="usage">Usage</h2>
|
||||
<p>Once <code>pomo</code> is installed you need to initialize it’s database.</p>
|
||||
|
||||
<pre><code class="language-bash">pomo init
|
||||
</code></pre>
|
||||
|
||||
<p>Start a 4 pomodoro session at 25 minute intervals:</p>
|
||||
|
||||
<pre><code class="language-bash">pomo start -t my-project "write some codes"
|
||||
</code></pre>
|
||||
|
||||
<h2 id="configuration">Configuration</h2>
|
||||
|
||||
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">pomo init
|
||||
</code></pre></div><p>Start a 4 pomodoro session at 25 minute intervals:</p>
|
||||
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">pomo start -t my-project <span style="color:#e6db74">"write some codes"</span>
|
||||
</code></pre></div><h2 id="configuration">Configuration</h2>
|
||||
<p>Pomo has a few configuration options which can be read from a JSON file in Pomo’s state directory <code>~/.pomo/config.json</code>.</p>
|
||||
|
||||
<h3 id="colors">colors</h3>
|
||||
|
||||
<p>You can map colors to specific tags in the <code>colors</code> field.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code class="language-json">{
|
||||
"colors": {
|
||||
"my-project": "hiyellow",
|
||||
"another-project": "green"
|
||||
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-json" data-lang="json">{
|
||||
<span style="color:#f92672">"colors"</span>: {
|
||||
<span style="color:#f92672">"my-project"</span>: <span style="color:#e6db74">"hiyellow"</span>,
|
||||
<span style="color:#f92672">"another-project"</span>: <span style="color:#e6db74">"green"</span>
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="integrations">Integrations</h2>
|
||||
|
||||
</code></pre></div><h2 id="integrations">Integrations</h2>
|
||||
<h3 id="status-bars">Status Bars</h3>
|
||||
|
||||
<p>The Pomo CLI can output the current state of a running task session via the <code>pomo status</code>
|
||||
making it easy to script and embed it’s output in various Linux status bars.</p>
|
||||
|
||||
<h4 id="polybar-https-github-com-jaagr-polybar"><a href="https://github.com/jaagr/polybar">Polybar</a></h4>
|
||||
|
||||
<h4 id="polybarhttpsgithubcomjaagrpolybar"><a href="https://github.com/jaagr/polybar">Polybar</a></h4>
|
||||
<p>You can create a module with the <code>custom/script</code> type and
|
||||
embed Pomo’s status output in your Polybar:</p>
|
||||
|
||||
<pre><code class="language-ini">[module/pomo]
|
||||
type = custom/script
|
||||
interval = 1
|
||||
exec = pomo status
|
||||
</code></pre>
|
||||
|
||||
<h2 id="roadmap">Roadmap</h2>
|
||||
|
||||
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ini" data-lang="ini"><span style="color:#66d9ef">[module/pomo]</span>
|
||||
<span style="color:#a6e22e">type</span> <span style="color:#f92672">=</span> <span style="color:#e6db74">custom/script</span>
|
||||
<span style="color:#a6e22e">interval</span> <span style="color:#f92672">=</span> <span style="color:#e6db74">1</span>
|
||||
<span style="color:#a6e22e">exec</span> <span style="color:#f92672">=</span> <span style="color:#e6db74">pomo status</span>
|
||||
</code></pre></div><h2 id="roadmap">Roadmap</h2>
|
||||
<ul>
|
||||
<li>Generate charts/burn down</li>
|
||||
<li>??</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="credits">Credits</h2>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://cirillocompany.de/pages/pomodoro-technique/book/">pomodoro technique</a></li>
|
||||
<li><a href="https://openclipart.org/detail/262421/tomato-by-rones">logo by rones</a></li>
|
||||
|
|
@ -225,5 +85,14 @@ exec = pomo status
|
|||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
</main>
|
||||
|
||||
|
||||
</div><div id="footer">
|
||||
<small>
|
||||
2021
|
||||
</small>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -1,14 +1,10 @@
|
|||
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>Pomo</title>
|
||||
<link>/pomo/</link>
|
||||
<description>Recent content on Pomo</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-us</language>
|
||||
|
||||
<atom:link href="/pomo/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
|
||||
<language>en-us</language><atom:link href="/pomo/index.xml" rel="self" type="application/rss+xml" />
|
||||
</channel>
|
||||
</rss>
|
||||
|
|
@ -1,20 +1,11 @@
|
|||
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
|
||||
xmlns:xhtml="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<url>
|
||||
<loc>/pomo/categories/</loc>
|
||||
<priority>0</priority>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
</url><url>
|
||||
<loc>/pomo/</loc>
|
||||
<priority>0</priority>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
</url><url>
|
||||
<loc>/pomo/tags/</loc>
|
||||
<priority>0</priority>
|
||||
</url>
|
||||
|
||||
</urlset>
|
||||
|
|
@ -1,14 +1,10 @@
|
|||
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>Tags on Pomo</title>
|
||||
<link>/pomo/tags/</link>
|
||||
<description>Recent content in Tags on Pomo</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-us</language>
|
||||
|
||||
<atom:link href="/pomo/tags/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
|
||||
<language>en-us</language><atom:link href="/pomo/tags/index.xml" rel="self" type="application/rss+xml" />
|
||||
</channel>
|
||||
</rss>
|
||||
Loading…
Reference in New Issue