Convert docs to slim
Marcin Kulik
11 years ago
parent
8efb95252e
commit
438e962a5a
@ -1,13 +0,0 @@
|
||||
<h1>Docs</h1>
|
||||
|
||||
<ul class="delimited">
|
||||
<li>
|
||||
<%= link_to_category 'About', docs_path(:about), :about %>
|
||||
</li>
|
||||
<li>
|
||||
<%= link_to_category 'Getting started', docs_path(:record), :record %>
|
||||
</li>
|
||||
<li>
|
||||
<%= link_to_category 'Recorder options', docs_path(:options), :options %>
|
||||
</li>
|
||||
</ul>
|
||||
@ -0,0 +1,6 @@
|
||||
h1 Docs
|
||||
|
||||
ul.delimited
|
||||
li = link_to_category 'About', docs_path(:about), :about
|
||||
li = link_to_category 'Getting started', docs_path(:record), :record
|
||||
li = link_to_category 'Recorder options', docs_path(:options), :options
|
||||
@ -1,47 +0,0 @@
|
||||
<%= markdown do %>
|
||||
|
||||
# About
|
||||
|
||||
Asciinema is the simplest way to record your terminal and share the recordings
|
||||
with your fellow geeks.
|
||||
|
||||
It's a free service built with open-source technologies (check the
|
||||
[source](https://github.com/sickill/asciinema.org)
|
||||
[code](https://github.com/sickill/asciinema)) aiming to be a "go to" place
|
||||
for everyone who want to share his terminal Voodoo.
|
||||
|
||||
## Parts
|
||||
|
||||
The service consists of two parts:
|
||||
|
||||
* Terminal recording utility
|
||||
* This site with web based player
|
||||
|
||||
Terminal recorder is a [Python
|
||||
script](https://github.com/sickill/asciinema/blob/master/bin/asciinema)
|
||||
that acts as a middleman
|
||||
([pseudo-terminal](http://en.wikipedia.org/wiki/Pseudo_terminal) specifically)
|
||||
between your shell and your terminal, recording all terminal activity and
|
||||
uploading it to [asciinema.org](http://asciinema.org) site.
|
||||
|
||||
Web based player is a JavaScript implementation of
|
||||
[VT102 ANSI terminal](http://en.wikipedia.org/wiki/VT102), supporting most ANSI
|
||||
control codes and sequences, all text attributes and
|
||||
[256 colors](<%= color_check_asciicast_path %>).
|
||||
|
||||
## Authors
|
||||
|
||||
Asciinema was created by <a href="/~sickill">Marcin Kulik</a> with the help of
|
||||
[Michał Wróbel](https://github.com/sparrovv).
|
||||
|
||||
## Getting in touch
|
||||
|
||||
[twitter.com/asciinema](https://twitter.com/asciinema) |
|
||||
[twitter.com/sickill](https://twitter.com/sickill)
|
||||
|
||||
## Contributing
|
||||
|
||||
[Source code](https://github.com/sickill/asciinema.org) |
|
||||
[Issues](https://github.com/sickill/asciinema.org/issues)
|
||||
|
||||
<% end -%>
|
||||
@ -0,0 +1,45 @@
|
||||
markdown:
|
||||
|
||||
# About
|
||||
|
||||
Asciinema is the simplest way to record your terminal and share the recordings
|
||||
with your fellow geeks.
|
||||
|
||||
It's a free service built with open-source technologies (check the
|
||||
[source](https://github.com/sickill/asciinema.org)
|
||||
[code](https://github.com/sickill/asciinema)) aiming to be a "go to" place
|
||||
for everyone who want to share his terminal Voodoo.
|
||||
|
||||
## Parts
|
||||
|
||||
The service consists of two parts:
|
||||
|
||||
* Terminal recording utility
|
||||
* This site with web based player
|
||||
|
||||
Terminal recorder is a [Python
|
||||
script](https://github.com/sickill/asciinema/blob/master/bin/asciinema)
|
||||
that acts as a middleman
|
||||
([pseudo-terminal](http://en.wikipedia.org/wiki/Pseudo_terminal) specifically)
|
||||
between your shell and your terminal, recording all terminal activity and
|
||||
uploading it to [asciinema.org](http://asciinema.org) site.
|
||||
|
||||
Web based player is a JavaScript implementation of
|
||||
[VT102 ANSI terminal](http://en.wikipedia.org/wiki/VT102), supporting most ANSI
|
||||
control codes and sequences, all text attributes and
|
||||
[256 colors](<%= color_check_asciicast_path %>).
|
||||
|
||||
## Authors
|
||||
|
||||
Asciinema was created by <a href="/~sickill">Marcin Kulik</a> with the help of
|
||||
[Michał Wróbel](https://github.com/sparrovv).
|
||||
|
||||
## Getting in touch
|
||||
|
||||
[twitter.com/asciinema](https://twitter.com/asciinema) |
|
||||
[twitter.com/sickill](https://twitter.com/sickill)
|
||||
|
||||
## Contributing
|
||||
|
||||
[Source code](https://github.com/sickill/asciinema.org) |
|
||||
[Issues](https://github.com/sickill/asciinema.org/issues)
|
||||
@ -1,24 +0,0 @@
|
||||
<%= markdown do %>
|
||||
|
||||
# Recorder options
|
||||
|
||||
See the list of available options with:
|
||||
|
||||
$ asciinema -h
|
||||
usage: asciinema [-h] [-i] [-y] [-c <command>] [-t <title>] [action]
|
||||
|
||||
Asciicast recorder+uploader.
|
||||
|
||||
Actions:
|
||||
rec record asciicast (this is the default when no action given)
|
||||
upload upload recorded (but not uploaded) asciicasts
|
||||
auth authenticate and/or claim recorded asciicasts
|
||||
|
||||
Optional arguments:
|
||||
-c command run specified command instead of shell ($SHELL)
|
||||
-t title specify title of recorded asciicast
|
||||
-y don't prompt for confirmation
|
||||
-h, --help show this help message and exit
|
||||
--version show version information
|
||||
|
||||
<% end -%>
|
||||
@ -0,0 +1,22 @@
|
||||
markdown:
|
||||
|
||||
# Recorder options
|
||||
|
||||
See the list of available options with:
|
||||
|
||||
$ asciinema -h
|
||||
usage: asciinema [-h] [-i] [-y] [-c <command>] [-t <title>] [action]
|
||||
|
||||
Asciicast recorder+uploader.
|
||||
|
||||
Actions:
|
||||
rec record asciicast (this is the default when no action given)
|
||||
upload upload recorded (but not uploaded) asciicasts
|
||||
auth authenticate and/or claim recorded asciicasts
|
||||
|
||||
Optional arguments:
|
||||
-c command run specified command instead of shell ($SHELL)
|
||||
-t title specify title of recorded asciicast
|
||||
-y don't prompt for confirmation
|
||||
-h, --help show this help message and exit
|
||||
--version show version information
|
||||
@ -1,58 +0,0 @@
|
||||
<%= markdown do %>
|
||||
|
||||
# Getting started
|
||||
|
||||
## 1. Install recorder
|
||||
|
||||
### Linux
|
||||
|
||||
To install/update asciinema recorder, open a terminal and run following
|
||||
command:
|
||||
|
||||
$ curl -sL get.asciinema.org | bash
|
||||
|
||||
### OSX (via Homebrew)
|
||||
|
||||
Install with:
|
||||
|
||||
$ brew install https://raw.github.com/gist/3875486/asciiio.rb --HEAD
|
||||
|
||||
Later update with:
|
||||
|
||||
$ brew upgrade asciinema
|
||||
|
||||
### OSX (no Homebrew)
|
||||
|
||||
If you don't use Homebrew then install/update with:
|
||||
|
||||
$ curl -sL get.asciinema.org | bash
|
||||
|
||||
## 2. Record
|
||||
|
||||
Open your terminal and run following command:
|
||||
|
||||
$ asciinema
|
||||
|
||||
New shell instance will be opened and everything you'll do in it will be
|
||||
recorded. When you're ready to upload simply exit the shell with `exit`
|
||||
command or just hit `<C-d>`.
|
||||
|
||||
## 3. Create profile (optional)
|
||||
|
||||
If you want your recordings to be assigned to your asciinema profile and to be
|
||||
able to edit/delete them run this and follow instructions:
|
||||
|
||||
$ asciinema auth
|
||||
|
||||
If you skip this step now, you can always run above command later and all
|
||||
previously recorded asciicasts will get automatically assigned to your new
|
||||
profile.
|
||||
|
||||
Btw, see [my profile](/~sickill).
|
||||
|
||||
## Advanced options
|
||||
|
||||
The recorder supports several command-line options. See
|
||||
[here](<%= docs_path(:options) %>) for details.
|
||||
|
||||
<% end %>
|
||||
@ -0,0 +1,56 @@
|
||||
markdown:
|
||||
|
||||
# Getting started
|
||||
|
||||
## 1. Install recorder
|
||||
|
||||
### Linux
|
||||
|
||||
To install/update asciinema recorder, open a terminal and run following
|
||||
command:
|
||||
|
||||
$ curl -sL get.asciinema.org | bash
|
||||
|
||||
### OSX (via Homebrew)
|
||||
|
||||
Install with:
|
||||
|
||||
$ brew install https://raw.github.com/gist/3875486/asciiio.rb --HEAD
|
||||
|
||||
Later update with:
|
||||
|
||||
$ brew upgrade asciinema
|
||||
|
||||
### OSX (no Homebrew)
|
||||
|
||||
If you don't use Homebrew then install/update with:
|
||||
|
||||
$ curl -sL get.asciinema.org | bash
|
||||
|
||||
## 2. Record
|
||||
|
||||
Open your terminal and run following command:
|
||||
|
||||
$ asciinema
|
||||
|
||||
New shell instance will be opened and everything you'll do in it will be
|
||||
recorded. When you're ready to upload simply exit the shell with `exit`
|
||||
command or just hit `<C-d>`.
|
||||
|
||||
## 3. Create profile (optional)
|
||||
|
||||
If you want your recordings to be assigned to your asciinema profile and to be
|
||||
able to edit/delete them run this and follow instructions:
|
||||
|
||||
$ asciinema auth
|
||||
|
||||
If you skip this step now, you can always run above command later and all
|
||||
previously recorded asciicasts will get automatically assigned to your new
|
||||
profile.
|
||||
|
||||
Btw, see [my profile](/~sickill).
|
||||
|
||||
## Advanced options
|
||||
|
||||
The recorder supports several command-line options. See
|
||||
[here](#{docs_path(:options)}) for details.
|
||||
Loading…
Reference in New Issue