Skip to content

Commit

Permalink
Merge pull request #14 from sebnitu/update/jekyll
Browse files Browse the repository at this point in the history
Update/jekyll
  • Loading branch information
sebnitu committed Nov 3, 2016
2 parents 2b3a857 + 5028d26 commit 39d3434
Show file tree
Hide file tree
Showing 210 changed files with 16,375 additions and 30,596 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,9 @@ Thumbs.db
###############
node_modules
.sass-cache/

# Jekyll Stuff #
################
docs/_site
docs/.jekyll-metadata
docs/Gemfile.lock
24 changes: 24 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
source "https://rubygems.org"
ruby RUBY_VERSION

# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
# gem "jekyll", "3.2.1"

# This is the default theme for new Jekyll sites. You may change this to anything you like.
# gem "minima"

# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
gem "github-pages", group: :jekyll_plugins

# If you have any plugins, put them here!
# group :jekyll_plugins do
# gem "jekyll-github-metadata", "~> 1.0"
# end
141 changes: 141 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.7)
i18n (~> 0.7)
json (~> 1.7, >= 1.7.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.4.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.10.0)
colorator (1.1.0)
ethon (0.9.0)
ffi (>= 1.3.0)
execjs (2.7.0)
faraday (0.9.2)
multipart-post (>= 1.2, < 3)
ffi (1.9.14)
forwardable-extended (2.6.0)
gemoji (2.1.0)
github-pages (93)
activesupport (= 4.2.7)
github-pages-health-check (= 1.2.0)
jekyll (= 3.2.1)
jekyll-coffeescript (= 1.0.1)
jekyll-feed (= 0.5.1)
jekyll-gist (= 1.4.0)
jekyll-github-metadata (= 2.0.2)
jekyll-mentions (= 1.1.3)
jekyll-paginate (= 1.1.0)
jekyll-redirect-from (= 0.11.0)
jekyll-sass-converter (= 1.3.0)
jekyll-seo-tag (= 2.0.0)
jekyll-sitemap (= 0.10.0)
jemoji (= 0.7.0)
kramdown (= 1.11.1)
liquid (= 3.0.6)
listen (= 3.0.6)
mercenary (~> 0.3)
minima (= 1.0.1)
rouge (= 1.11.1)
terminal-table (~> 1.4)
github-pages-health-check (1.2.0)
addressable (~> 2.3)
net-dns (~> 0.8)
octokit (~> 4.0)
public_suffix (~> 1.4)
typhoeus (~> 0.7)
html-pipeline (2.4.2)
activesupport (>= 2)
nokogiri (>= 1.4)
i18n (0.7.0)
jekyll (3.2.1)
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-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-feed (0.5.1)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-github-metadata (2.0.2)
jekyll (~> 3.1)
octokit (~> 4.0)
jekyll-mentions (1.1.3)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.11.0)
jekyll (>= 2.0)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
jekyll-seo-tag (2.0.0)
jekyll (~> 3.1)
jekyll-sitemap (0.10.0)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
jemoji (0.7.0)
activesupport (~> 4.0)
gemoji (~> 2.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0)
json (1.8.3)
kramdown (1.11.1)
liquid (3.0.6)
listen (3.0.6)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9.7)
mercenary (0.3.6)
mini_portile2 (2.1.0)
minima (1.0.1)
minitest (5.9.0)
multipart-post (2.0.0)
net-dns (0.8.0)
nokogiri (1.6.8)
mini_portile2 (~> 2.1.0)
pkg-config (~> 1.1.7)
octokit (4.3.0)
sawyer (~> 0.7.0, >= 0.5.3)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
pkg-config (1.1.7)
public_suffix (1.5.3)
rb-fsevent (0.9.7)
rb-inotify (0.9.7)
ffi (>= 0.5.0)
rouge (1.11.1)
safe_yaml (1.0.4)
sass (3.4.22)
sawyer (0.7.0)
addressable (>= 2.3.5, < 2.5)
faraday (~> 0.8, < 0.10)
terminal-table (1.7.0)
unicode-display_width (~> 1.1)
thread_safe (0.3.5)
typhoeus (0.8.0)
ethon (>= 0.8.0)
tzinfo (1.2.2)
thread_safe (~> 0.1)
unicode-display_width (1.1.0)

PLATFORMS
ruby

DEPENDENCIES
github-pages

RUBY VERSION
ruby 2.0.0p481

BUNDLED WITH
1.13.6
34 changes: 13 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
![BaseWeb](http://f.cl.ly/items/201U3Y1g0c2M1u1Z3i0n/baseweb-banner.png "BaseWeb — A fresh front-end development framework.")
![BaseWeb](https://d3vv6lp55qjaqc.cloudfront.net/items/39132g291E2e2k3I0e2e/baseweb-logo.png "BaseWeb")

Currently v1.2.1
Currently v2.0.0

## About
BaseWeb is a SCSS front-end development library and framework built to make working on web based projects more enjoyable. It&#39;s focused on keeping your projects simple, organized and responsive.
BaseWeb is a fresh SCSS front-end development framework and library built to help keep your projects simple, organized and responsive.

### Upcoming Features
The main features being worked on right now are blocks. The following list of blocks are currently on the production list:

* Modals
* Tooltips
* Menus
* Pagination
* Tabs
* Pagination
* Tooltips

## Documentation
Documentation is currently being worked on and you can view them if you clone or download the repo. There will also be an online version at [http://getbaseweb.com/](http://getbaseweb.com/).
Documentation can be found at [http://getbaseweb.com/](http://getbaseweb.com/). A copy of the docs are also included when downloading this repo. If you see any errors or problems with the docs, please feel free to open an issue ticket and I'll do my best to get things fixed. BaseWeb is built on [Jekyll](https://jekyllrb.com/).

### Upcoming Features
Upcoming features and updates to BaseWeb documentation:
Expand All @@ -30,31 +29,24 @@ Upcoming features and updates to BaseWeb documentation:
BaseWeb uses [Node](https://nodejs.org/), [Jake](http://jakejs.com/) and [Jake-Builds](https://github.com/sebnitu/jake-builds) for building both the source and docs. For more information on how to update build scripts using this stack, make sure to checkout [Jake-Builds](https://github.com/sebnitu/jake-builds).

### Node Packages
Run `npm install` to install required node modules for build scripts. This is the following node stack used to build BaseWeb assets and documentation files:
Run `sudo npm install` to install required node modules for build scripts. This is the following node stack used to build BaseWeb assets and documentation files:

| Node Modules | Versions | Description |
|----------------|------------|-------------|
| `jake` | `8.0.12` | The JavaScript build tool for Node.js |
| `node-watch` | `0.3.4` | Used in handling the watch task |
| `node-sass` | `3.4.2` | Used for compiling and minifying src and doc CSS from SCSS files |
| `uglify-js` | `2.4.19` | Used to compile and minify our JavaScript files |
| `mustache` | `2.0.0` | Used to build our HTML files for docs, examples and readme |
| `imagemin` | `3.1.0` | Used to optimize our image files |

*Keep in mind that if you use the imagemin module, [Jpegtran](http://jpegclub.org/jpegtran/) should be installed globally. You can install it with [Homebrew](http://brew.sh/) using: `brew install jpeg`*
| `node-watch` | `0.4.*` | Used in handling the watch task |
| `node-sass` | `3.10.*` | Used for compiling and minifying CSS from SCSS files |
| `uglify-js` | `2.7.*` | Used to compile and minify our JavaScript files |

### Jake Tasks
To see the full list of available Jake tasks for a project, use `jake -ls`. The following tasks are available for building BaseWeb and related files:

| Jake Tasks | Description |
|-----------------------|------------------------------------------------------|
| `jake build` | Build everything |
| `jake build:scss` | Compiles and minifies SCSS |
| `jake build:js` | Compiles and minifies JavaScript |
| `jake build:img` | Optimizes images |
| `jake build:docs` | Build documentation |
| `jake build:examples` | Build examples |
| `jake build:js` | Compiles and minifies JS |
| `jake watch` | Watch for change to files and rebuild if they change |

## Copyright and License

BaseWeb and BaseWeb documentation copyright (c) 2016 [Sebastian Nitu](http://sebnitu.com). BaseWeb is released under the [MIT license](https://github.com/sebnitu/BaseWeb/blob/master/LICENSE) and BaseWeb documentation is released under [Creative Commons](https://github.com/sebnitu/BaseWeb/blob/master/docs/LICENSE).
BaseWeb and BaseWeb documentation copyright (c) 2016 [Sebastian Nitu](http://sebnitu.com). BaseWeb is released under the [MIT license](https://github.com/sebnitu/BaseWeb/blob/master/LICENSE) and BaseWeb documentation is released under [Creative Commons](https://github.com/sebnitu/BaseWeb/blob/master/docs/LICENSE).
42 changes: 42 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing these this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'jekyll serve'. If you change this file, please restart the server process.

# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: BaseWeb
email: me@sebnitu.com
description: > # this means to ignore newlines until "baseurl:"
BaseWeb is a fresh SCSS front-end development framework and library built to help keep your projects simple, organized and responsive.
baseurl: "" # the subpath of your site, e.g. /blog
url: "http://sebnitu.com" # the base hostname & protocol for your site
twitter_username: sebnitu
github_username: sebnitu

# Build settings
markdown: kramdown
source: docs
destination: docs/_site
permalink: pretty
host: localhost
port: 8080
exclude: [
'assets/img/raw',
'assets/css/baseweb.css',
'assets/js/jquery.docready.js',
'assets/js/jquery.function.js'
]

# Collections
# collections:
# pages:
# output: true
Loading

0 comments on commit 39d3434

Please sign in to comment.