-
Notifications
You must be signed in to change notification settings - Fork 171
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit ac946d5
Showing
41 changed files
with
2,081 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
_site/ | ||
.sass-cache/ | ||
.jekyll-metadata |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Not Found | ||
permalink: /404.html | ||
sitemap: false | ||
--- | ||
|
||
This page doesn't exist! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
source 'https://rubygems.org' | ||
|
||
gem 'jekyll', '3.3.1' | ||
|
||
group :jekyll_plugins do | ||
gem 'jekyll-sitemap', '0.11.0' | ||
gem 'jekyll-seo-tag', '2.0.0' | ||
gem 'jekyll-feed', '0.7.2' | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
GEM | ||
remote: https://rubygems.org/ | ||
specs: | ||
addressable (2.4.0) | ||
colorator (1.1.0) | ||
ffi (1.9.14) | ||
forwardable-extended (2.6.0) | ||
jekyll (3.3.1) | ||
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.7.2) | ||
jekyll-sass-converter (1.5.0) | ||
sass (~> 3.4) | ||
jekyll-seo-tag (2.0.0) | ||
jekyll (~> 3.1) | ||
jekyll-sitemap (0.11.0) | ||
addressable (~> 2.4.0) | ||
jekyll-watch (1.5.0) | ||
listen (~> 3.0, < 3.1) | ||
kramdown (1.13.1) | ||
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) | ||
rb-fsevent (0.9.8) | ||
rb-inotify (0.9.7) | ||
ffi (>= 0.5.0) | ||
rouge (1.11.1) | ||
safe_yaml (1.0.4) | ||
sass (3.4.22) | ||
|
||
PLATFORMS | ||
ruby | ||
|
||
DEPENDENCIES | ||
jekyll (= 3.3.1) | ||
jekyll-feed (= 0.7.2) | ||
jekyll-seo-tag (= 2.0.0) | ||
jekyll-sitemap (= 0.11.0) | ||
|
||
BUNDLED WITH | ||
1.12.5 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2016 CloudCannon | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Edition | ||
|
||
Product documentation template for Jekyll. Browse through a [live demo](https://long-pig.cloudvent.net/). | ||
Start documenting your product, application, service or website with this configurable theme. | ||
|
||
![Edition template screenshot](images/_screenshot.png) | ||
|
||
Edition was made by [CloudCannon](http://cloudcannon.com/), the Cloud CMS for Jekyll. | ||
Find more templates and themes at [Jekyll Tips](http://jekyll.tips/templates/). | ||
|
||
Learn Jekyll with step-by-step tutorials and videos at [Jekyll Tips](http://jekyll.tips/). | ||
|
||
## Features | ||
|
||
* Two column layout | ||
* Full text search | ||
* Pre-styled components | ||
* Auto-generated navigation based on category | ||
* Optimised for editing in [CloudCannon](http://cloudcannon.com/) | ||
* Change log | ||
* RSS/Atom feed | ||
* SEO tags | ||
* Google Analytics | ||
|
||
## Setup | ||
|
||
1. Add your site and author details in `_config.yml`. | ||
2. Get a workflow going to see your site's output (with [CloudCannon](https://app.cloudcannon.com/) or Jekyll locally). | ||
|
||
## Develop | ||
|
||
Edition was built with [Jekyll](http://jekyllrb.com/) version 3.3.1, but should support newer versions as well. | ||
|
||
Install the dependencies with [Bundler](http://bundler.io/): | ||
|
||
~~~bash | ||
$ bundle install | ||
~~~ | ||
|
||
Run `jekyll` commands through Bundler to ensure you're using the right versions: | ||
|
||
~~~bash | ||
$ bundle exec jekyll serve | ||
~~~ | ||
|
||
## Editing | ||
|
||
Edition is already optimised for adding, updating and removing documentation pages in CloudCannon. | ||
|
||
### Documentation pages | ||
|
||
* Add, update or remove a documentation page in the *Documentation* collection. | ||
* Change the category of a documentation page to move it to another section in the navigation. | ||
* Documentation pages are organised in the navigation by category, with URLs based on the path inside the `_docs` folder. | ||
|
||
### Change log | ||
|
||
* Add, update or remove change log entries from your posts. | ||
* Tag entries as minor or major in the front matter. | ||
|
||
### Search | ||
|
||
* Add `excluded_in_search: true` to any documentation page's front matter to exclude that page in the search results. | ||
|
||
### Navigation | ||
|
||
* Change `site.show_full_navigation` to control all or only the current navigation group being open. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# ---- | ||
# Site | ||
|
||
title: Edition Template | ||
url: "https://long-pig.cloudvent.net" | ||
baseurl: | ||
google_analytics_key: | ||
show_full_navigation: true | ||
|
||
# Values for the jekyll-seo-tag gem (https://github.com/jekyll/jekyll-seo-tag) | ||
logo: /siteicon.png | ||
description: Product documentation template for Jekyll. | ||
author: | ||
name: | ||
email: | ||
twitter: # twitter username without the @ symbol | ||
social: | ||
name: Edition Template | ||
links: | ||
- https://github.com/CloudCannon/edition-jekyll-template | ||
|
||
# ----- | ||
# Build | ||
|
||
permalink: pretty | ||
|
||
gems: | ||
- jekyll-sitemap | ||
- jekyll-seo-tag | ||
- jekyll-feed | ||
|
||
exclude: | ||
- Gemfile | ||
- Gemfile.lock | ||
- README.md | ||
- LICENCE | ||
|
||
collections: | ||
docs: | ||
title: Documentation | ||
permalink: /:path/ | ||
output: true | ||
|
||
defaults: | ||
- | ||
scope: | ||
path: "" | ||
values: | ||
layout: default | ||
- | ||
scope: | ||
path: "" | ||
type: "docs" | ||
values: | ||
seo: | ||
type: Article | ||
_comments: | ||
category: Group navigation links with this field | ||
order: Used to sort links in the navigation | ||
- | ||
scope: | ||
path: "" | ||
type: "posts" | ||
values: | ||
_comments: | ||
type: Marks the impact of this release | ||
|
||
# ----------- | ||
# CloudCannon | ||
|
||
types: | ||
- minor | ||
- major |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: | ||
category: | ||
order: 1 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
title: Facebook | ||
category: Contact Syncing | ||
order: 1 | ||
--- | ||
|
||
Sync your Facebook contacts with ChatApp. Any of your Facebook friends with ChatApp accounts are automatically added to your contact list! | ||
|
||
> Signing up with Facebook automatically starts syncing contacts. | ||
To sync your contacts: | ||
|
||
1. Open your *User Settings* | ||
2. Select the **Connect Facebook** button | ||
3. Authorise ChatApp | ||
|
||
![](//placehold.it/800x600) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: Phone | ||
category: Contact Syncing | ||
order: 2 | ||
--- | ||
|
||
Sync your phone contacts with ChatApp. ChatApp saves your phone contacts and adds anyone with an email address to your contact list! | ||
|
||
> Syncing contacts with your phone restores any previously synced contacts. | ||
To sync your contacts: | ||
|
||
1. Open your *User Settings* on your phone app | ||
2. Select the **Sync Contacts** button | ||
3. Authorise ChatApp permissions | ||
4. Select some or all of your contacts | ||
|
||
![](//placehold.it/800x600) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: Android | ||
category: Devices | ||
order: 2 | ||
--- | ||
|
||
Use ChatApp on all of your Android devices. Every version is supported. | ||
|
||
To install ChatApp on your device: | ||
|
||
1. Open the Google Play Store | ||
2. Search for ChatApp | ||
3. Select **Install** | ||
|
||
![](//placehold.it/800x600) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: iOS | ||
category: Devices | ||
order: 1 | ||
--- | ||
|
||
Use ChatApp on most of your Apple devices. Only the latest versions are supported. | ||
|
||
To install ChatApp on your device: | ||
|
||
1. Open the App Store | ||
2. Search for ChatApp | ||
3. Select **Install** | ||
|
||
![](//placehold.it/800x600) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
title: Documents | ||
category: Media | ||
order: 3 | ||
--- | ||
|
||
Share documents with your friends! Send work or school projects from your computer or phone. | ||
|
||
To share a document: | ||
|
||
1. Open a message with someone | ||
2. Select the **Send Media** button | ||
3. Pick a document | ||
|
||
> Changes made to documents after sending are not saved back, you'll have to get contacts to send you updated versions. | ||
![](//placehold.it/800x600) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
title: Images | ||
category: Media | ||
order: 1 | ||
--- | ||
|
||
Share images with your friends! Send photos and pictures from your computer, phone or camera. | ||
|
||
> Images are stored until you choose to remove them. | ||
To share an image: | ||
|
||
1. Open a message with someone | ||
2. Select the **Send Media** button | ||
3. Pick an image | ||
|
||
![](//placehold.it/800x600) | ||
|
||
Supported types: | ||
|
||
* JPEG | ||
* PNG | ||
* BMP | ||
* GIF | ||
|
||
Unsupported types: | ||
|
||
* SVG | ||
* WEBP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
title: Video | ||
category: Media | ||
order: 2 | ||
--- | ||
|
||
Share video to your friends! Send videos from your computer, phone, camera or YouTube. | ||
|
||
To share a video: | ||
|
||
1. Open a message with someone | ||
2. Select the **Send Media** button | ||
3. Pick a video or paste a YouTube link | ||
|
||
> Videos can use up a lot of bandwidth so be aware of your mobile data. | ||
![](//placehold.it/800x600) |
Oops, something went wrong.