Skip to content

Commit

Permalink
Merge pull request #1 from jwu910/CIO-67-landing-page
Browse files Browse the repository at this point in the history 
CIO-67 Formatting stuff
  • Loading branch information
@jma26
jma26 committed May 22, 2018
2 parents fc54f29 + 012f8e3 commit 5f85f5c
Show file tree
Hide file tree
Showing 2 changed files with 108 additions and 100 deletions.
13 changes: 9 additions & 4 deletions .editorconfig
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.html]
indent_size = 4
indent_style = tab

[*.js]
indent_size = 2
indent_style = space
insert_final_newline = false
trim_trailing_whitespace = true
indent_style = space
195 changes: 99 additions & 96 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,97 +1,100 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title> Check-it-Out </title>
<!-- Import latos font -->
<link href="https://fonts.googleapis.com/css?family=Lato:400,700,900" rel="stylesheet">
<link rel="stylesheet" type="text/css" href="./main.css">
</head>
<body>
<header>
<h1 class="headline"> Check It Out </h1>
<h2 class="subheadline"> Less Keystrokes. More Work Done.</h2>
<div class="link-container">
<a href="https://badge.fury.io/js/check-it-out"><img src="https://badge.fury.io/js/check-it-out.svg" alt="npm version" height="18" class="npm-badges"></a>
<a href="https://badge.fury.io/gh/jwu910%2Fcheck-it-out"><img src="https://badge.fury.io/gh/jwu910%2Fcheck-it-out.svg" alt="GitHub version" class="npm-badges"/></a>
</div>
</header>
<div class="main">
<div class="info-section">
<h2 class="title"> What is Check It Out? </h2>
<img src="../assets/images/checkit-intro.gif" alt="checkit-intro gif">
<p class="contents"> Check it out, before you checkout. </p>
<p class="contents"> Change branches with a single command. Check It Out visualizes branches and remotes in your current project. Long Branch Names? Forget it! </p>
<p class="contents"> Fewer commands, fewer keystrokes, better productivity! </p>
</div>
<div class="require-section">
<h2 class="title"> Requirements </h2>
<p class="require-links"><a href="https://nodejs.org/en/blog/release/v7.0.0/">Node >= v6.0 </a></p>
<p class="require-links"><a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">Git</a> - Required for core features </p>
</div>
<div class="install-section">
<h2 class="title"> Installation </h2>
<p class="contents"> We're on <a href="https://www.npmjs.org/package/check-it-out">NPM!</a></p>
<pre> npm install -g check-it-out </pre>
<h2 class="title"> Installing from source </h2>
<p class="contents"> Fork or clone the repository </p>
<pre> git clone https://github.com/jwu910/check-it-out.git </pre>
<p class="contents"> Navigate to your repository and run </p>
<pre> npm install </pre>
<p class="contents"> Creat a symbolic link to your entry point </p>
<h3> Linux/Mac </h3>
<p class="contents"> Navigate to a desired destination directory currently in your pathway </p>
<pre> ln -s /path/to/check-it-out/index.js checkit </pre>
</div>
<div class="usage-section">
<h2 class="title"> Usage </h2>
<p class="contents"> Run this command to list local and remote branches! </p>
<pre> checkit </pre>
<img src="../assets/images/checkit-usage.gif" alt="checkit-usage gif">
<p class="contents"> Call git log on current highlighted branch with <code> [space] </code></p>
<img src="../assets/images/checkit-log.gif" alt="checkit-log gif">
<table>
<tr>
<th> Command </th>
<th> Description </th>
</tr>
<tr>
<td class="command"> j/k, down/up </td>
<td class="description"> Navigate the list </td>
</tr>
<tr>
<td class="command"> h/l, left/right </td>
<td class="description"> Previous/Next remote </td>
</tr>
<tr>
<td class="command"> r </td>
<td class="description"> Refresh list with a fetch and prune </td>
</tr>
<tr>
<td class="command"> enter </td>
<td class="description"> Select highlighted item </td>
</tr>
<tr>
<td class="command"> space </td>
<td class="description"> Git log </td>
</tr>
<tr>
<td class="command"> q, C-c, esc </td>
<td class="description"> Quit </td>
</tr>
</table>
</div>
<div class="contribute-section">
<h2 class="title"> Contributing </h2>
<p class="contents"> Please refer to <a href="../CONTRIBUTING.md"> Contributing Guidelines.</a></p>
</div>
</div>
<footer>
<h2 class="contributors"> Design by Rebecca Hong and Built by Jesse Ma </h2>
<h2 class="license"> License </h2>
<h2 class="license"> MIT @ <a href="https://www.npmjs.com/~jwu910"> Joshua Wu</a></h2>
</footer>
</body>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta content="initial-scale=1.0, width=device-width" name="viewport">
<meta content="ie=edge" http-equiv="X-UA-Compatible">
<title> Check-it-Out </title>
<link href="https://fonts.googleapis.com/css?family=Lato:400,700,900" rel="stylesheet">
<link href="./main.css" rel="stylesheet" type="text/css">
</head>
<body>
<header>
<h1 class="headline"> Check It Out </h1>
<h2 class="subheadline"> Less Keystrokes. More Work Done.</h2>
<div class="link-container">
<a href="https://badge.fury.io/js/check-it-out">
<img alt="npm version" class="npm-badges" src="https://badge.fury.io/js/check-it-out.svg">
</a>
<a href="https://badge.fury.io/gh/jwu910%2Fcheck-it-out">
<img alt="GitHub version" class="npm-badges" src="https://badge.fury.io/gh/jwu910%2Fcheck-it-out.svg"/>
</a>
</div>
</header>
<div class="main">
<div class="info-section">
<h2 class="title"> What is Check It Out? </h2>
<img alt="checkit-intro gif" src="../assets/images/checkit-intro.gif">
<p class="contents"> Check it out, before you checkout. </p>
<p class="contents"> Change branches with a single command. Check It Out visualizes branches and remotes in your current project. Long Branch Names? Forget it! </p>
<p class="contents"> Fewer commands, fewer keystrokes, better productivity! </p>
</div>
<div class="require-section">
<h2 class="title"> Requirements </h2>
<p class="require-links"><a href="https://nodejs.org/en/blog/release/v7.0.0/">Node >= v6.0 </a></p>
<p class="require-links"><a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">Git</a> - Required for core features </p>
</div>
<div class="install-section">
<h2 class="title"> Installation </h2>
<p class="contents"> We're on <a href="https://www.npmjs.org/package/check-it-out">NPM!</a></p>
<pre> npm install -g check-it-out </pre>
<h2 class="title"> Installing from source </h2>
<p class="contents"> Fork or clone the repository </p>
<pre> git clone https://github.com/jwu910/check-it-out.git </pre>
<p class="contents"> Navigate to your repository and run </p>
<pre> npm install </pre>
<p class="contents"> Creat a symbolic link to your entry point </p>
<h3> Linux/Mac </h3>
<p class="contents"> Navigate to a desired destination directory currently in your pathway </p>
<pre> ln -s /path/to/check-it-out/index.js checkit </pre>
</div>
<div class="usage-section">
<h2 class="title"> Usage </h2>
<p class="contents"> Run this command to list local and remote branches! </p>
<pre> checkit </pre>
<img alt="checkit-usage gif" src="../assets/images/checkit-usage.gif">
<p class="contents"> Call git log on current highlighted branch with <code> [space] </code></p>
<img alt="checkit-log gif" src="../assets/images/checkit-log.gif">
<table>
<tr>
<th> Command </th>
<th> Description </th>
</tr>
<tr>
<td class="command"> j/k, down/up </td>
<td class="description"> Navigate the list </td>
</tr>
<tr>
<td class="command"> h/l, left/right </td>
<td class="description"> Previous/Next remote </td>
</tr>
<tr>
<td class="command"> r </td>
<td class="description"> Refresh list with a fetch and prune </td>
</tr>
<tr>
<td class="command"> enter </td>
<td class="description"> Select highlighted item </td>
</tr>
<tr>
<td class="command"> space </td>
<td class="description"> Git log </td>
</tr>
<tr>
<td class="command"> q, C-c, esc </td>
<td class="description"> Quit </td>
</tr>
</table>
</div>
<div class="contribute-section">
<h2 class="title"> Contributing </h2>
<p class="contents"> Please refer to <a href="../CONTRIBUTING.md"> Contributing Guidelines.</a></p>
</div>
</div>
<footer>
<h2 class="contributors"> Design by Rebecca Hong and Built by Jesse Ma </h2>
<h2 class="license"> License </h2>
<h2 class="license"> MIT @ <a href="https://www.npmjs.com/~jwu910"> Joshua Wu</a></h2>
</footer>
</body>
</html>

0 comments on commit 5f85f5c

Please sign in to comment.