Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add remark lint #66

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ site/_site/
coverage
.ruby-version
.sass-cache
node_modules/
npm-debug.log
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,28 @@ This is the website of [The Lounge](https://thelounge.github.io/).
## What is The Lounge?

The Lounge is a web IRC client. More information can be found at
https://github.com/thelounge/lounge.
<https://github.com/thelounge/lounge>.

## Development

You need to install [Jekyll](https://jekyllrb.com/):

```
sudo apt-get install ruby1.9.3 build-essential nodejs-legacy
sudo gem install jekyll redcarpet
```
sudo apt-get install ruby1.9.3 build-essential nodejs-legacy
sudo gem install jekyll redcarpet

Now go ahead and clone:

```
git clone https://github.com/thelounge/thelounge.github.io
cd thelounge.github.io/
```
git clone https://github.com/thelounge/thelounge.github.io
cd thelounge.github.io/
npm install

Run Jekyll:

```
jekyll serve --watch --safe
```
jekyll serve --watch --safe

After you're done editing, make sure to run the linter:

npm run lint

## License

Expand Down
24 changes: 12 additions & 12 deletions _docs/client/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Example: `/close`

Aliases:

- [/leave](#leave)
- [/part](#part)
- [/leave](#leave)
- [/part](#part)

## /connect

Expand All @@ -50,7 +50,7 @@ Example: `/connect irc.freenode.org`

Aliases:

- [/server](#server)
- [/server](#server)

## /deop

Expand Down Expand Up @@ -96,8 +96,8 @@ Example: `/leave`

Aliases:

- [/close](#close)
- [/part](#part)
- [/close](#close)
- [/part](#part)

## /me

Expand Down Expand Up @@ -159,8 +159,8 @@ Example: `/quote`

Aliases:

- [/raw](#raw)
- [/send](#send)
- [/raw](#raw)
- [/send](#send)

## /raw

Expand All @@ -170,8 +170,8 @@ Example: `/raw`

Aliases:

- [/quote](#quote)
- [/send](#send)
- [/quote](#quote)
- [/send](#send)

## /say

Expand All @@ -185,8 +185,8 @@ Example: `/send`

Aliases:

- [/quote](#quote)
- [/raw](#raw)
- [/quote](#quote)
- [/raw](#raw)

## /server

Expand All @@ -196,7 +196,7 @@ Example: `/server irc.freenode.org`

Aliases:

- [/connect](#connect)
- [/connect](#connect)

## /slap

Expand Down
28 changes: 10 additions & 18 deletions _docs/client/keyboard_shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,34 +15,26 @@ order: 3.2

To quickly jump between channels:

__WIN / LINUX:__
**WIN / LINUX:**

```
CTRL + UP ARROW # Move up one channel
CTRL + DOWN ARROW # Move down
```
CTRL + UP ARROW # Move up one channel
CTRL + DOWN ARROW # Move down

__OS X:__
**OS X:**

```
COMMAND + UP ARROW # Move up one channel
COMMAND + DOWN ARROW # Move down
```
COMMAND + UP ARROW # Move up one channel
COMMAND + DOWN ARROW # Move down

## Clear buffer

Quickly hides all the messages in the current channel.

_This is the same as `/clear`._

__WIN / LINUX:__
**WIN / LINUX:**

```
CTRL + SHIFT + L
```
CTRL + SHIFT + L

__OS X:__
**OS X:**

```
COMMAND + K
```
COMMAND + K
18 changes: 5 additions & 13 deletions _docs/deployment/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@ To run a container using an official image, follow the steps below;

Start the container:

```
$ docker run --name=thelounge --publish=9000:9000 --detach thelounge/lounge
```
$ docker run --name=thelounge --publish=9000:9000 --detach thelounge/lounge

### Step 2:

Expand All @@ -43,26 +41,20 @@ To manually build a Docker image, follow the steps below;

Clone the Docker repository of The Lounge:

```
$ git clone https://github.com/thelounge/docker-lounge.git
$ cd docker-lounge
```
$ git clone https://github.com/thelounge/docker-lounge.git
$ cd docker-lounge

### Step 2:

Build a Docker image according to our [Dockerfile](https://hub.docker.com/r/thelounge/lounge/~/dockerfile/) and name it `lounge`:

```
$ docker build --tag=lounge .
```
$ docker build --tag=lounge .

### Step 3:

Create a new container named `thelounge` from the `lounge` image and run the app in it:

```
$ docker run --name=thelounge --publish=9000:9000 --detach lounge
```
$ docker run --name=thelounge --publish=9000:9000 --detach lounge

### Step 4:

Expand Down
36 changes: 11 additions & 25 deletions _docs/deployment/heroku.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,60 +31,46 @@ This document will explain how to install The Lounge on Heroku. If you want to l

Begin by logging in with the [Heroku toolbelt](https://toolbelt.heroku.com/):

```
heroku login
```
heroku login

### Step 2:

Clone the repository and install The Lounge from source:

```
git clone https://github.com/thelounge/lounge
cd lounge
npm install
NODE_ENV=production npm run build
```
git clone https://github.com/thelounge/lounge
cd lounge
npm install
NODE_ENV=production npm run build

### Step 3:

In the `lounge/` directory, run:

```
heroku create
```
heroku create

### Step 4: (optional)

_This step is only useful if you want to run The Lounge with users accounts._

Create a `Procfile` and edit the content to look like this:

```
web: node index --private --home /app
```
web: node index --private --home /app

_You can read more about Procfiles [here](https://devcenter.heroku.com/articles/procfile)._

To create users, run the following in the `lounge/` directory:

```
./index.js --home . add <username>
```
./index.js --home . add <username>

### Step 5:

Time to publish to Heroku!

If you've made any changes to the repository (like adding users or the Profile), don't forget to save the changes with `git`:

```
git add .
git commit -m "Added Heroku files"
```
git add .
git commit -m "Added Heroku files"

And with that done, lets go ahead and push to Heroku:

```
git push heroku
```
git push heroku
14 changes: 5 additions & 9 deletions _docs/deployment/passenger.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,16 @@ This document will explain how to install The Lounge on Phusion Passenger. You c

Clone the repository and install The Lounge from source:

```
git clone https://github.com/thelounge/lounge
cd lounge
npm install
NODE_ENV=production npm run build
```
git clone https://github.com/thelounge/lounge
cd lounge
npm install
NODE_ENV=production npm run build

### Step 3:

Add a link from `index.js` to `app.js` (Passenger requires an `app.js` file):

```
ln index.js app.js
```
ln index.js app.js

### Step 4:

Expand Down
Loading