Skip to content

Commit 763fbd0

Browse files
author
Rush
committed
First commit
0 parents  commit 763fbd0

File tree

188 files changed

+8724
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

188 files changed

+8724
-0
lines changed

‎.editorconfig

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

‎.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
_site
2+
.DS_Store
3+
*.sublime-project
4+
*.sublime-workspace
5+
codekit-config.json
6+
node_modules
7+
_asset_bundler_cache
8+
.sass-cache

‎.jshintrc

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"bitwise": true,
3+
"browser": true,
4+
"curly": true,
5+
"eqeqeq": true,
6+
"eqnull": true,
7+
"es5": false,
8+
"esnext": true,
9+
"immed": true,
10+
"jquery": true,
11+
"latedef": true,
12+
"newcap": true,
13+
"noarg": true,
14+
"node": true,
15+
"strict": false,
16+
"trailing": false,
17+
"undef": true,
18+
"multistr": true,
19+
"expr": true
20+
}

‎Gemfile

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Skinny Bones Gemfile
2+
source "https://rubygems.org"
3+
4+
gem 'jekyll', '2.5.3'
5+
gem 'jekyll-sitemap'
6+
gem 'octopress', '~> 3.0'

‎Gemfile.lock

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
blankslate (2.1.2.4)
5+
classifier-reborn (2.0.4)
6+
fast-stemmer (~> 1.0)
7+
coffee-script (2.4.1)
8+
coffee-script-source
9+
execjs
10+
coffee-script-source (1.9.1.1)
11+
colorator (0.1)
12+
execjs (2.6.0)
13+
fast-stemmer (1.0.2)
14+
ffi (1.9.10)
15+
ffi (1.9.10-x64-mingw32)
16+
jekyll (2.5.3)
17+
classifier-reborn (~> 2.0)
18+
colorator (~> 0.1)
19+
jekyll-coffeescript (~> 1.0)
20+
jekyll-gist (~> 1.0)
21+
jekyll-paginate (~> 1.0)
22+
jekyll-sass-converter (~> 1.0)
23+
jekyll-watch (~> 1.1)
24+
kramdown (~> 1.3)
25+
liquid (~> 2.6.1)
26+
mercenary (~> 0.3.3)
27+
pygments.rb (~> 0.6.0)
28+
redcarpet (~> 3.1)
29+
safe_yaml (~> 1.0)
30+
toml (~> 0.1.0)
31+
jekyll-coffeescript (1.0.1)
32+
coffee-script (~> 2.2)
33+
jekyll-gist (1.3.5)
34+
jekyll-paginate (1.1.0)
35+
jekyll-sass-converter (1.3.0)
36+
sass (~> 3.2)
37+
jekyll-sitemap (0.9.0)
38+
jekyll-watch (1.3.0)
39+
listen (~> 3.0)
40+
kramdown (1.9.0)
41+
liquid (2.6.3)
42+
listen (3.0.4)
43+
rb-fsevent (>= 0.9.3)
44+
rb-inotify (>= 0.9)
45+
mercenary (0.3.5)
46+
octopress (3.0.11)
47+
jekyll (>= 2.0)
48+
mercenary (~> 0.3.2)
49+
octopress-deploy
50+
octopress-escape-code (~> 2.0)
51+
octopress-hooks (~> 2.0)
52+
redcarpet (~> 3.0)
53+
titlecase
54+
octopress-deploy (1.3.0)
55+
colorator
56+
octopress-escape-code (2.0.6)
57+
octopress-hooks (~> 2.0)
58+
octopress-hooks (2.6.1)
59+
jekyll (>= 2.0)
60+
parslet (1.5.0)
61+
blankslate (~> 2.0)
62+
posix-spawn (0.3.11)
63+
pygments.rb (0.6.3)
64+
posix-spawn (~> 0.3.6)
65+
yajl-ruby (~> 1.2.0)
66+
rb-fsevent (0.9.6)
67+
rb-inotify (0.9.5)
68+
ffi (>= 0.5.0)
69+
redcarpet (3.3.3)
70+
safe_yaml (1.0.4)
71+
sass (3.4.19)
72+
titlecase (0.1.1)
73+
toml (0.1.2)
74+
parslet (~> 1.5.0)
75+
yajl-ruby (1.2.1)
76+
77+
PLATFORMS
78+
ruby
79+
x64-mingw32
80+
81+
DEPENDENCIES
82+
jekyll (= 2.5.3)
83+
jekyll-sitemap
84+
octopress (~> 3.0)

‎Gruntfile.js

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
'use strict';
2+
module.exports = function(grunt) {
3+
4+
grunt.initConfig({
5+
pkg: grunt.file.readJSON('package.json'),
6+
jshint: {
7+
options: {
8+
jshintrc: '.jshintrc'
9+
},
10+
all: [
11+
'Gruntfile.js',
12+
'js/*.js',
13+
'!js/main.js'
14+
]
15+
},
16+
watch: {
17+
js: {
18+
files: [
19+
'<%= jshint.all %>'
20+
],
21+
tasks: ['jshint', 'uglify', 'surround'],
22+
options: {
23+
livereload: true
24+
}
25+
},
26+
},
27+
uglify: {
28+
dist: {
29+
options: {
30+
banner: '/*! <%= pkg.name %> - v<%= pkg.version %> - ' + '<%= grunt.template.today("yyyy-mm-dd") %> */',
31+
compress: true,
32+
beautify: false,
33+
mangle: false
34+
},
35+
files: {
36+
'js/main.js': [
37+
'js/plugins/*.js',
38+
'js/_*.js'
39+
]
40+
}
41+
}
42+
},
43+
surround: {
44+
src: 'js/main.js',
45+
options: {
46+
overwrite: true,
47+
prepend: '---\n---',
48+
},
49+
},
50+
imagemin: {
51+
dist: {
52+
options: {
53+
optimizationLevel: 7,
54+
progressive: true
55+
},
56+
files: [{
57+
expand: true,
58+
cwd: 'images/',
59+
src: '{,*/}*.{png,jpg,jpeg}',
60+
dest: 'images/'
61+
}]
62+
}
63+
},
64+
imgcompress: {
65+
dist: {
66+
options: {
67+
optimizationLevel: 7,
68+
progressive: true
69+
},
70+
files: [{
71+
expand: true,
72+
cwd: 'images/',
73+
src: '{,*/}*.{png,jpg,jpeg}',
74+
dest: 'images/'
75+
}]
76+
}
77+
},
78+
svgmin: {
79+
dist: {
80+
files: [{
81+
expand: true,
82+
cwd: 'images/',
83+
src: '{,*/}*.svg',
84+
dest: 'images/'
85+
}]
86+
}
87+
},
88+
});
89+
90+
// Load tasks
91+
grunt.loadNpmTasks('grunt-contrib-jshint');
92+
grunt.loadNpmTasks('grunt-contrib-watch');
93+
grunt.loadNpmTasks('grunt-contrib-uglify');
94+
grunt.loadNpmTasks('grunt-newer');
95+
grunt.loadNpmTasks('grunt-contrib-imagemin');
96+
grunt.loadNpmTasks('grunt-svgmin');
97+
grunt.loadNpmTasks('grunt-imgcompress');
98+
grunt.loadNpmTasks('grunt-surround');
99+
100+
// Register tasks
101+
grunt.registerTask('scripts', ['watch', 'uglify']);
102+
grunt.registerTask('images', ['newer:imgcompress', 'newer:svgmin']);
103+
};

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2014 Michael Rose
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
2+
Algorithmia Developer Center
3+
========
4+
5+
6+
7+
Welcome to the repository for Algorithmia's API. Here you will find the API reference, as well as some documentation on getting started with the API and basic set up.
8+
9+
10+
11+
These docs are built on Jekyll. Learn more over at [the official Jekyll page](http://jekyllrb.com/).
12+
13+
Running locally
14+
------------------------------
15+
16+
### Prerequisites
17+
18+
You're going to need:
19+
20+
- **Linux or OS X** — Windows may work, but is unsupported.
21+
- **Ruby, version 1.9.3 or newer**
22+
- **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal.
23+
24+
### Getting Set Up
25+
26+
1. Fork this repository on Github.
27+
2. Clone *your forked repository* with `git clone https://github.com/YOURUSERNAME/dev-center.git`
28+
3. `cd dev-center`
29+
4. Install all dependencies: `bundle install`. If you are having trouble with some of the gems, try running `bundle update`, then run `bundle install` again.
30+
5. Start the test server: `bundle exec jekyll serve`
31+
32+
You can now see the developer center at <http://localhost:4000>.
33+
34+
35+
Making changes
36+
-------------
37+
38+
###Project Organization
39+
40+
All posts, layouts, includes, stylesheets, assets, and whatever else is grouped nicely under the root folder.
41+
42+
Find all posts under the `_posts` directory.
43+
44+
The compiled Jekyll site outputs to _site/.
45+
46+
47+
### Writing Posts
48+
49+
The first thing that goes in each new post is the [YAML front-matter](http://jekyllrb.com/docs/frontmatter/). Below is an example of front-matter:
50+
51+
```
52+
---
53+
layout: article
54+
title: "Example post!"
55+
date: 2016-01-05 11:39:38
56+
categories: guides example
57+
comments: false #true by default but currently disabled in config (optional field)
58+
share: false #true by default (optional field)
59+
sitemap: false #true by default (optional field)
60+
---
61+
```
62+
63+
For our purposes, the minimum you will need is `layout`, `title`, `date`, & `categories`. The other fields only need to be present if you are overriding the default.
64+
65+
Posts are organized according to category as a subdirectory of `_posts`. Each post follows the same naming convention: `YYYY-MM-DD-post-title.md`.
66+
67+
Here is an example:
68+
```
69+
_posts/guides/2016-01-05-example-post.md
70+
```
71+
72+
73+
74+
Contributing
75+
-------------
76+
77+
First, fork the repository and follow the instructions above to get set up. Make sure all your changes work locally. When you are ready, make a pull request to this repo and we will review the changes. Be sure to describe the changes, attach screenshots of any cosmetic changes, and if applicable, link to the open issue.
78+
79+
80+
Need Help? Found a bug?
81+
----------------
82+
83+
If you find a bug, can't follow the documentation or have a question – [submit an issue!](https://github.com/algorithmiaio/dev-center/issues)
84+
85+
We will respond to you or reach out for more information as soon as possible. And, of course, feel free to submit pull requests with bug fixes or changes.

‎_config.yml

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Site wide configuration
2+
3+
title: Algorithmia Developer Center
4+
description: Resources tutorials and guides for Algorithmia.
5+
logo: AlgorithmiaLogo120x120.png # 120x120 px default image used for Twitter summary card
6+
teaser: AlgorithmiaLogo420x87.png # 400x250 px default teaser image used in image archive grid
7+
locale: en
8+
url: http://localhost:4000
9+
# url: http://algorithmia.com
10+
# Used to generate absolute URLs in sitemap.xml, atom.xml, and for generating canonical URLs in <head>.
11+
# When developing locally either comment this out or use something like http://localhost:4000 so all assets load properly.
12+
# Don’t include a trailing /.
13+
14+
# Jekyll configuration
15+
16+
sass:
17+
sass_dir: _sass
18+
style: compressed
19+
permalink: /:categories/:title/
20+
kramdown:
21+
toc_levels: 1..2
22+
highlighter: pygments
23+
gems:
24+
- jekyll-sitemap
25+
26+
27+
# Site owner
28+
owner:
29+
name:
30+
email: mia@algorithmia.com
31+
twitter: twitter.com/algorithmia
32+
google:
33+
ad-client:
34+
ad-slot:
35+
bio:
36+
avatar: bio-photo.jpg # 160x160 px image for author byline
37+
disqus-shortname: # disabled for now. Each post can use the comments feature flag to allow or disallow commenting via diqus.
38+
39+
40+
exclude: ["lib", "config.rb", ".sass-cache", "Capfile", "config", "log", "Rakefile", "Rakefile.rb", "tmp", "*.sublime-project", "*.sublime-workspace", "Gemfile", "Gemfile.lock", "README.md", "LICENSE", "node_modules", "Gruntfile.js", "package.json"]

0 commit comments

Comments
 (0)