Commit 889ff66c authored by Sean Packham's avatar Sean Packham

First commit

New website layout, some content imports, docs import.
parent 56dc0684
_site/
.sass-cache/
.jekyll-metadata
.ruby-version
.DS_Store
source 'https://rubygems.org'
ruby '~> 2.4.1'
gem 'jekyll', '~> 3.4.5'
group :jekyll_plugins do
gem 'jekyll-feed', '~> 0.9.2'
gem 'jekyll-redirect-from', '~> 0.12.1'
end
GEM
remote: https://rubygems.org/
specs:
addressable (2.5.1)
public_suffix (~> 2.0, >= 2.0.2)
colorator (1.1.0)
ffi (1.9.18)
forwardable-extended (2.6.0)
jekyll (3.4.5)
addressable (~> 2.4)
colorator (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-feed (0.9.2)
jekyll (~> 3.3)
jekyll-redirect-from (0.12.1)
jekyll (~> 3.3)
jekyll-sass-converter (1.5.0)
sass (~> 3.4)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
kramdown (1.14.0)
liquid (3.0.6)
listen (3.0.8)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
mercenary (0.3.6)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
public_suffix (2.0.5)
rb-fsevent (0.10.2)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (1.11.1)
safe_yaml (1.0.4)
sass (3.5.1)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
PLATFORMS
ruby
DEPENDENCIES
jekyll (~> 3.4.5)
jekyll-feed (~> 0.9.2)
jekyll-redirect-from (~> 0.12.1)
RUBY VERSION
ruby 2.4.1p111
BUNDLED WITH
1.15.2
MIT License
Copyright (c) 2017 Rocket.Chat
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
# www.rocket.chat
The Rocket.Chat website, documentation and handbook
The Rocket.Chat website, documentation and handbook.
In development, latest `master` viewable on [GitHub Pages](https://rocketchat.github.io/www.rocket.chat)
## Site structure
We chose Jekyll and GitLab pages because together they offer the most supported and user friendly way for others to fork, edit, preview and contribute documentation without having to setup a local development environment just to write copy, add images or manage files.
For developers, only use templates and includes when they are needed. Creating a template per page or splitting templates into many parts that are only included once makes it challenging to maintain and contribute to the project.
### Templates
The `default.html` template is the base template used by pages or other templates (only `post.html` at the moment).
Only create a Template if it will be used by more than one page. Rather add the structure and content to the page e.g. see `index.html`.
### Includes
Like Templates, only create an Include if it will be used in more than one Template.
### Styles
When changing styles, bump the `version` number in `config.yml` to force browsers to load the new version.
Define Template or Page styles in their own file with the same name as the Template or Page (e.g `_templates/default.html`) and then include the style in `styles.scss`.
Only define variables for values that are used in multiple places and need to vary. Use contextually relevant names instead of calling it by the current value it holds e.g use `$body-color` instead of `$color-light-blue`. If you change the value of the variable in the second case, you have to update the name and everywhere it is referenced.
title: Rocket.Chat
description: The portal for all your Rocket.Chat documentation needs
url: https://rocketchat.github.io/www.rocket.chat
permalink: pretty
# bump if alterting styles
version: 1
# set default template for posts
defaults:
- scope:
path: ""
type: posts
values:
layout: post
sass:
style: compressed
sass_dir: _sass
plugins_dir:
- jekyll-feed
- jekyll-redirect-from
exclude:
- Gemfile
- Gemfile.lock
- README.md
<div class="callout">
<div class="left">
<h3>Ready to try?</h3>
<p>Try our fully featured Browser Demo or Download Rocket.Chat to your device</p>
</div>
<div class="right">
<a class="button dark" href="https://open.rocket.chat/">Explore Demo</a>
<a class="button bright" href="https://rocket.chat/download">Download Now</a>
</div>
</div>
<!DOCTYPE html>
<html lang="en">
<head>
<title>{{ site.title }}{% if page.title %} - {{ page.title }}{% endif %}</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="canonical" href="{{ page.url | absolute_url }}">
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="/feed.xml">
<link rel="stylesheet" href="{{ site.url }}/styles.css?v={{ site.version }}">
<link rel="shortcut icon" href="/favicon.ico?v=1"/>
<script async defer src="https://buttons.github.io/buttons.js"></script>
</head>
<body class="{{ page.layout }}">
<div class="wrapper">
<header>
<h2><a href="{{ site.url }}">{{ site.title }}</a></h2>
<ul>
<li><a {% if page.class == 'features' %}class="active"{%endif%} href="{{ site.url }}/features/">Features</a></li>
<li><a {% if page.class == 'products' %}class="active"{%endif%} href="{{ site.url }}/products/">Products</a></li>
<li><a {% if page.class == 'cloud' %}class="active"{%endif%} href="{{ site.url }}/cloud/">Hosting</a></li>
<li><a {% if page.class == 'docs' %}class="active"{%endif%} href="{{ site.url }}/docs/">Docs</a></li>
<li><a {% if page.class == 'blog' %}class="active"{%endif%} href="{{ site.url }}/blog/">Blog</a></li>
<li><a {% if page.class == 'contact' %}class="active"{%endif%} href="{{ site.url }}/contact">Contact</a></li>
<li><a href="https://demo.rocket.chat" target="_blank">Try Demo</a></li>
<li><a {% if page.class == 'download' %}class="active"{%endif%} href="{{ site.url }}/download/">Download</a></li>
</ul>
<div class="clear"></div>
</header>
<div class="main">
{{ content }}
</div>
</div>
<footer>
<div class="callout">
<div class="left">
<h3>Ready to try?</h3>
<p>Try our fully featured Browser Demo or download a Rocket.Chat client</p>
</div>
<div class="right">
<a class="button" href="https://open.rocket.chat/">Explore Demo</a>
<a class="button highlight" href="https://rocket.chat/download">Download Now</a>
</div>
<div class="clear">
</div>
</div>
<div class="links">
<div class="left">
<h4>Rocket.Chat on GitHub</h4>
<div class="">
<a class="github-button" href="https://github.com/RocketChat/Rocket.Chat"
data-icon="octicon-star" data-size="large" data-show-count="true"
aria-label="Star RocketChat/Rocket.Chat on GitHub">Star</a>
<a class="github-button" href="https://github.com/RocketChat/Rocket.Chat/fork"
data-icon="octicon-repo-forked" data-size="large" data-show-count="true"
aria-label="Fork RocketChat/Rocket.Chat on GitHub">Fork</a>
</div>
</div>
<div class="right">
<ul>
<h4>Get Started</h4>
<li><a href="https://demo.rocket.chat/" target="_blank">Try Demo</a></li>
<li><a href="https://rocket.chat/download">Download</a></li>
</ul>
<ul>
<h4>Product</h4>
<li><a href="{{ site.url }}/features/">Features</a></li>
<li><a href="{{ site.url }}/products/">Solutions</a></li>
<li><a href="{{ site.url }}/cloud/">Hosting</a></li>
<li><a href="{{ site.url }}/partners/">Partners</a></li>
<li><a href="{{ site.url }}/docs/">Docs</a></li>
</ul>
<ul>
<h4>Company</h4>
<li><a href="{{ site.url }}/about/">About</a></li>
<li><a href="{{ site.url }}/team/">Team</a></li>
<li><a href="{{ site.url }}/press/">Press</a></li>
<li><a href="{{ site.url }}/blog/">Blog</a></li>
<li><a href="{{ site.url }}/contact/">Contact</a></li>
<li><a href="{{ site.url }}/jobs/">Jobs</a></li>
</ul>
<ul>
<h4>Legal</h4>
<li><a href="{{ site.url }}/privacy/">Privacy</a></li>
<li><a href="{{ site.url }}/terms/">Terms of service</a></li>
<li><a href="https://www.stickermule.com/user/1070688638/stickers" target="_blank">Stickers</a></li>
<li><a href="https://shop.spreadshirt.com/rocketchat" target="_blank">Swag store</a></li>
</ul>
</div>
</div>
</footer>
{% if jekyll.environment != "development" %}
<!-- Google Analytics -->
{% endif %}
</body>
</html>
---
layout: default
class: docs
---
{{ content }}
---
layout: default
class: blog
---
<small>
{{ page.date | date: "%b %-d, %Y" }} -
{% assign words = content | number_of_words %}
{% if words < 360 %} 1 min {% else %} {{ words | divided_by:120 }} mins {% endif %} read
</small>
<h1>{{ page.title | escape }}</h1>
{{ content }}
// pygments github.com style
.highlight {
.hll { background-color: #ffffcc }
.c { color: #999988; font-style: italic }
.err { color: #a61717; background-color: #e3d2d2 }
.k { color: #000000; font-weight: bold }
.o { color: #000000; font-weight: bold }
.cm { color: #999988; font-style: italic }
.cp { color: #999999; font-weight: bold; font-style: italic }
.c1 { color: #999988; font-style: italic }
.cs { color: #999999; font-weight: bold; font-style: italic }
.gd { color: #000000; background-color: #ffdddd }
.ge { color: #000000; font-style: italic }
.gr { color: #aa0000 }
.gh { color: #999999 }
.gi { color: #000000; background-color: #ddffdd }
.go { color: #888888 }
.gp { color: #555555 }
.gs { font-weight: bold }
.gu { color: #aaaaaa }
.gt { color: #aa0000 }
.kc { color: #000000; font-weight: bold }
.kd { color: #000000; font-weight: bold }
.kn { color: #000000; font-weight: bold }
.kp { color: #000000; font-weight: bold }
.kr { color: #000000; font-weight: bold }
.kt { color: #445588; font-weight: bold }
.m { color: #009999 }
.s { color: #d01040 }
.na { color: #008080 }
.nb { color: #0086B3 }
.nc { color: #445588; font-weight: bold }
.no { color: #008080 }
.nd { color: #3c5d5d; font-weight: bold }
.ni { color: #800080 }
.ne { color: #990000; font-weight: bold }
.nf { color: #990000; font-weight: bold }
.nl { color: #990000; font-weight: bold }
.nn { color: #555555 }
.nt { color: #000080 }
.nv { color: #008080 }
.ow { color: #000000; font-weight: bold }
.w { color: #bbbbbb }
.mf { color: #009999 }
.mh { color: #009999 }
.mi { color: #009999 }
.mo { color: #009999 }
.sb { color: #d01040 }
.sc { color: #d01040 }
.sd { color: #d01040 }
.s2 { color: #d01040 }
.se { color: #d01040 }
.sh { color: #d01040 }
.si { color: #d01040 }
.sx { color: #d01040 }
.sr { color: #009926 }
.s1 { color: #d01040 }
.ss { color: #990073 }
.bp { color: #999999 }
.vc { color: #008080 }
.vg { color: #008080 }
.vi { color: #008080 }
.il { color: #009999 }
}
// variables
$body-color: #6c727a;
$body-background: #f7f8fa;
$body-line-height: 1.58;
$body-font-size: 15px;
$body-font-family:
-apple-system, BlinkMacSystemFont,
"Segoe UI", Helvetica, Arial, sans-serif,
"Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
$content-width: 920px;
$content-padding: 25px;
$wrapper-background: #ffffff;
$header-font-size: 14px;
$header-logo-font-size: 16px;
$footer-font-size: 14px;
$footer-color: #929db3;
$footer-background: #f7f8fa;
$footer-heading-font-size: 11px;
$footer-heading-color: #bcc5d6;
$heading-color: #414852;
$heading-color-hover: #414852;
$link-color: #1d74f5;
$link-hover-color: #6c727a;
$code-background: #eee8d5;
$code-color: #555555;
$code-border-color: #555555;
$code-font-size: 15px;
$code-font-family:
"Consolas", "Monaco", "Ubuntu Monospace",
"Courier New", monospace;
$button-color: #ffffff;
// dark grey
$background-primary: #414852;
// light grey
$background-secondary: #f7f8fa;
// blue, same as link-color
$background-highlight: #1d74f5;
// elements
* {
box-sizing: border-box;
}
a, a:visited {
color: $link-color;
text-decoration: none;
}
a:hover {
color: $link-hover-color;
text-decoration: underline;
}
a.button {
display: inline-block;
padding: 8px 14px;
border-radius: 2px;
background-color: $background-primary;
color: $button-color;
&.highlight {
background-color: $background-highlight;
}
}
h1, h2, h3, h4, h5, h6 {
margin: 0 0 15px;
font-weight: 600;
letter-spacing: -0.03em;
color: $heading-color;
a, a:visited {
text-decoration: none;
color: $heading-color-hover;
}
code {
font-size: inherit;
}
}
ul {
margin: 0 0 15px;
}
blockquote {
margin: 1.5em 0;
padding: 0 1em;
font-style: italic;
font-size: 20px;
}
code, pre {
background: $code-background;
color: $code-color;
font-family: $code-font-family;
font-size: $code-font-size;
@media(max-width: $content-width) {
overflow-x: scroll;
}
}
pre {
margin: 20px 0;
padding: 8px 10px;
border-top: 1px solid $code-border-color;
border-bottom: 1px solid $code-border-color;
}
img {
display: block;
max-width: 100%;
margin: 0 auto;
}
.clear {
clear: both;
}
// structure
html, body {
margin: 0;
padding: 0;
}
// use same background as footer to blend on short pages
body {
background: $body-background;
color: $body-color;
font-family: $body-font-family;
font-size: $body-font-size;
line-height: $body-line-height;
}
// wrap header and .main, give it a white background
.wrapper {
background: $wrapper-background;
}
header, .main, footer {
padding: 0 $content-padding $content-padding;
}
header {
max-width: $content-width;
margin: 0 auto;
padding-top: 15px;
font-size: $header-font-size;
h2 {
margin: 0;
display: inline-block;
font-size: $header-logo-font-size;
}
ul {
margin: 0;
padding: 0;
list-style: none;
float: right;
}
li {
display: inline-block;
padding-right: 18px;
}
a, a:visited {
text-decoration: none;
color: $heading-color;
}
a.active {
color: #000;
text-decoration: underline;
}
}
.main {
max-width: $content-width;
margin: 0 auto;
}
footer {
max-width: $content-width;
margin: 0 auto;
padding-top: 15px;
background-color: $footer-background;
color: $footer-color;
font-size: $footer-font-size;
.left {
float: left;
max-width: 40%;
}
.right {
float: right;
max-width: 60%;
}