Skip to content

Commit 9d02d0c

Browse files
koistyakoistya
committed
Add a static site generated from the docs folder
1 parent 8a93cc3 commit 9d02d0c

File tree

12 files changed

+355
-1
lines changed

12 files changed

+355
-1
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,6 @@ node_modules
2929
.cmd_history
3030
.cmd_history/*
3131
.cmd_history/cmd_historycash
32+
33+
# GitHub Pages site
34+
docs/dist

‎docs/assets/footer.css‎

Whitespace-only changes.

‎docs/assets/footer.ejs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<footer class="mdl-mini-footer">
2+
<div class="mdl-mini-footer__left-section">
3+
&copy; <a href="https://github.com/dthree">David Caccavella</a>
4+
</div>
5+
<div class="mdl-mini-footer__right-section">
6+
Love it? Cash is brand new! Give it a ★ or a tweet to help spread the word!
7+
</div>
8+
</footer>

‎docs/assets/header.css‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/**
2+
* Header styles
3+
*/
4+
5+
.mdl-layout__header-row {
6+
padding-left: 40px;
7+
}
8+
9+
.mdl-layout-title {
10+
font-family: 'Syncopate', 'Helvetica', sans-serif;
11+
}

‎docs/assets/header.ejs‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<header class="mdl-layout__header mdl-layout__header--waterfall">
2+
<div class="mdl-layout__header-row">
3+
<span class="mdl-layout-title">
4+
CASH
5+
</span>
6+
<!-- Add spacer, to align navigation to the right in desktop -->
7+
<div class="mdl-layout-spacer"></div>
8+
<!-- Top navigation -->
9+
<nav class="mdl-navigation">
10+
<a class="mdl-navigation__link mdl-typography--text-uppercase is-active" href="/">Overview</a>
11+
<a class="mdl-navigation__link mdl-typography--text-uppercase" href="/getting-started">Get Started</a>
12+
<a class="mdl-navigation__link mdl-typography--text-uppercase" href="/faq">FAQ</a>
13+
<a class="mdl-navigation__link mdl-typography--text-uppercase" href="https://github.com/dthree/cash">
14+
<i class="material-icons">link</i>
15+
<span>GitHub</span>
16+
</a>
17+
</nav>
18+
</div>
19+
</header>

‎docs/assets/main.css‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
/**
2+
* Core and layout styles
3+
*/
4+
5+
@import 'header.css';
6+
@import 'footer.css';
7+
8+
html, body {
9+
font-family: 'Roboto', 'Helvetica', sans-serif;
10+
margin: 0;
11+
padding: 0;
12+
}
13+
14+
.hero {
15+
background: rgb(0,130,116);
16+
color: white;
17+
text-align: center;
18+
padding: 4em 40px;
19+
}
20+
21+
.hero__title {
22+
font-family: 'Syncopate', 'Helvetica', sans-serif;
23+
padding: 0;
24+
margin: 0 0 16px;
25+
}
26+
27+
.hero__desc {
28+
font-size: 24px;
29+
}
30+
31+
.page {
32+
padding: 0 40px;
33+
}
34+
35+
.container {
36+
max-width: 800px;
37+
margin: 0 auto;
38+
}
39+
40+
@media screen and (max-width: 1024px) {
41+
42+
.hero {
43+
padding: 1.5em 16px;
44+
}
45+
46+
.page {
47+
padding: 0 16px;
48+
}
49+
50+
}

‎docs/assets/main.ejs‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!doctype html>
2+
<html class="no-js" lang="">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="x-ua-compatible" content="ie=edge">
6+
<title><%= title %></title>
7+
<meta name="description" content="<%= description %>">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="apple-touch-icon" href="apple-touch-icon.png">
10+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium|Syncopate" lang=en">
11+
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
12+
<link rel="stylesheet" href="https://code.getmdl.io/1.1.3/material.teal-pink.min.css">
13+
<link rel="stylesheet" href="main.css">
14+
</head>
15+
<body>
16+
<div class="mdl-layout mdl-js-layout mdl-layout--fixed-header">
17+
<%- include('header'); %>
18+
<main class="mdl-layout__content">
19+
<% if (id === 'home') { %><div class="hero">
20+
<h1 class="hero__title">CASH</h1>
21+
<p class="hero__desc">Cross-platform Linux without the suck</p>
22+
</div><% } %>
23+
<section class="page">
24+
<div class="container">
25+
<%- content %>
26+
</div>
27+
</section>
28+
<%- include('footer'); %>
29+
</main>
30+
</div>
31+
<script src="https://code.getmdl.io/1.1.3/material.min.js"></script>
32+
<script>
33+
window.ga=function(){ga.q.push(arguments)};ga.q=[];ga.l=+new Date;
34+
ga('create','UA-XXXXX-Y','auto');ga('send','pageview')
35+
</script>
36+
<script src="https://www.google-analytics.com/analytics.js" async defer></script>
37+
</body>
38+
</html>

‎docs/assets/main.js‎

Whitespace-only changes.

‎docs/faq.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
id: faq
3+
title: FAQ | Cash - cross-platform Linux without the suck
4+
---
5+
6+
## FAQ
7+
8+
#### Why Cash?
9+
10+
In its very essence, Cash replaces the Windows CLI prompt (`>`) with the Unix one (`$`), the dollar symbol.
11+
12+
Cash was most fitting in this sense:
13+
14+
> Ask and ye shall receive
15+
16+
```
17+
> cash
18+
$
19+
````
20+
21+
Cash is also a play on the word `bash`, and is actually[\[1\]](https://xkcd.com/906) a recursive acronym for Cash Shell.
22+
23+
Shout out to [@aseemk](https://github.com/aseemk) for donating the name.
24+
25+
26+
#### Doesn't ShellJS do this?
27+
28+
No.
29+
30+
For those who don't know, [ShellJS](https://github.com/shelljs/shelljs) is an awesome Node package that implements UNIX shell commands programatically in JavaScript. Check it out - really. While ShellJS was tremendously helpful in figuring out how to accomplish Cash, the two do not really conflict.
31+
32+
ShellJS gives the feel of UNIX commands in a code environment, but aims to implement the commands in a way that makes sense for a JavaScript library. This means that many commands return JavaScript objects, and some of the rougher and more dangerous edges of bash have been softened a bit.
33+
34+
For example, with cash:
35+
```javascript
36+
$('ls'); // 'node_modules\n'
37+
38+
$('echo foo > foo.txt');
39+
```
40+
41+
With ShellJS:
42+
```javascript
43+
ls(); // ['node_modules'];
44+
45+
echo('foo').to('foo.txt');

‎docs/getting-started.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
id: getting-started
3+
title: Getting Started | Cash - cross-platform Linux without the suck
4+
---
5+
6+
## Getting Started
7+
8+
- [Introduction](#introduction)
9+
- [Supported commands](#supported-commands)
10+
- [Configuration (.cashrc)](#configuration)
11+
- [Contributing](#contributing)
12+
- [FAQ](#faq)
13+
- [Team](#team)
14+
- [License](#license)
15+
- [Wiki](https://github.com/dthree/cash/wiki)
16+
17+
## Introduction
18+
19+
Cash is a project working on a cross-platform implementation of the most used Unix-based commands in pure JavaScript and with no external dependencies.
20+
21+
The goal of Cash is to open up these commands to the massive JavaScript community for the first time, and to provide a cleaner, simpler and flexible alternative to applications like Cygwin for those wanting the Linux feel on Windows.
22+
23+
Cash was built with strict attention to nearly exact implementations and excellent test coverage of over 200 unit tests.
24+
25+
26+
## Supported commands
27+
28+
The following commands are currently implemented:
29+
30+
- alias
31+
- cat
32+
- clear
33+
- cd
34+
- cp
35+
- echo
36+
- export
37+
- false
38+
- grep
39+
- head
40+
- kill
41+
- less
42+
- ls
43+
- mkdir
44+
- mv
45+
- pwd
46+
- rm
47+
- sort
48+
- source
49+
- tail
50+
- touch
51+
- true
52+
- unalias
53+
54+
Want more commands?
55+
56+
- [Vote on the next commands](https://github.com/dthree/cash/wiki/Roadmap)
57+
- [Help spread the word:](http://bit.ly/1LBEJ5s) More knowledge of Cash equals more contributors
58+
- [Contribute](#contributing)
59+
60+
61+
## Configuration
62+
63+
Want to configure things to your heart's content? Just add your configurations in a `.cashrc` file (`_cashrc` also works, for Windows folk) and put that in your home directory. This supports anything you can do inside a cash command prompt (`export`ing environmental variables, aliases, etc.).
64+
65+
## Contributing
66+
67+
- [Editing commands](https://github.com/dthree/cash/wiki/Contributing#editing-existing-commands)
68+
- [Adding new commands](https://github.com/dthree/cash/wiki/Contributing)
69+
70+
We are currently looking for Core Team members who can push forward Cash at a rapid rate. Are you an awesome developer up to the challenge? Send me a ping.
71+
72+
### Awesome contributors
73+
74+
- [@nfischer](https://github.com/nfischer): Added `source`, `export`, `true` and `false` commands, among several other contributions.
75+
- [@safinn](https://github.com/safinn): Added `clear` and `tail` commands.
76+
- [@legien](https://github.com/legien): Added `head` command.
77+
- [@cspotcode](https://github.com/cspotcode): Implemented template literal execution.

0 commit comments

Comments
 (0)