diff --git a/docs/config.json b/docs/config.json new file mode 100644 index 0000000..b8d15c3 --- /dev/null +++ b/docs/config.json @@ -0,0 +1,31 @@ +{ + "baseUrl": "/blur-admin/", + "locals": { + "url": "http://localhost:8080", + "name": "The Wintersmith's blog", + "owner": "Someone", + "description": "Ramblings of an immor(t)al demigod" + }, + "plugins": [ + "./plugins/paginator.coffee" + ], + "require": { + "moment": "moment", + "_": "underscore", + "typogr": "typogr" + }, + "jade": { + "pretty": true + }, + "markdown": { + "smartLists": true, + "smartypants": true + }, + "paginator": { + "perPage": 3, + "groupSort": { + "Quick Start": 1000, + "Customization": 900 + } + } +} diff --git a/docs/contents/articles/001-getting-started/index.md b/docs/contents/articles/001-getting-started/index.md new file mode 100644 index 0000000..f0a1fca --- /dev/null +++ b/docs/contents/articles/001-getting-started/index.md @@ -0,0 +1,43 @@ +--- +title: Getting Started +author: vl +sort: 999 +group: Quick Start +template: article.jade +--- + +## What is BlurAdmin? + +Blur admin is Angular front-end Admin Dashboard template. That means all data you can see on graphs, charts tables is hardcoded in Javascript. You can use any backend you want with it without limitations. + +## How can it help me? + +We believe that that at the moment a lot of business applications have some kind of admin interface inside of them. Sometimes it's not that obvious, but a lot of web applications have dashboard with panels, charts analytics. + +BlurAdmin aims to bootstrap development of your product and provide ecosystem for building a prototype or even production-ready application. + +Despite frameworks like Bootstrap provide a number of components, usually it's not enough of them to build real-world app. This template comes with lots of popular UI components with unified color scheme. + +As well you can use BlurAdmin for learning purposes. + +## List of features + +* Responsive layout +* High resolution +* Bootstrap CSS Framework +* Sass +* Gulp build +* AngularJS +* Jquery +* Jquery ui +* Charts (amChart, Chartist, Chart.js, Morris) +* Maps (Google, Leaflet, amMap) +* etc + +## I want to start developing with BlurAdmin + +Welcome abroad! + +You can start with [Installation Guidelines](/blur-admin/articles/002-installation-guidelines/). We describe there how can you download and run template on you local machine. + +Good luck and have fun! \ No newline at end of file diff --git a/docs/contents/articles/002-installation-guidelines/index.md b/docs/contents/articles/002-installation-guidelines/index.md new file mode 100644 index 0000000..e1358ae --- /dev/null +++ b/docs/contents/articles/002-installation-guidelines/index.md @@ -0,0 +1,46 @@ +--- +title: Installation Guidelines +author: vl +sort: 500 +group: Quick Start +template: article.jade +--- + +## Prerequisites + +Despite BlurAdmin can be run without any development experience, it would be much easier if you already know something about it. In general following instruction do allow to run local copy by complete newbie, but it doesn't answer questions that can arise in the process of installation. + +## Install tools + +If you don't havee any of these tools installed already, you will need to: +* Download and install [git](https://git-scm.com/) +* Download and install nodejs [https://nodejs.org](https://nodejs.org) + +**Note**: It seems like there are some problems with some libraries used in this template and old node versions. That's why we suggest you to have one of the latest. + +## Clone repository and install dependencies + +You will need to clone source code of BlurAdmin GitHub repository. To do this open console and execute following lines: +```bash +git clone https://github.com/akveo/blur-admin.git +``` +After repository is cloned, go inside of repository directory and install dependencies there: +```bash +cd blur-admin +npm install +``` +This will setup a working copy of BlurAdmin on your local machine + +## Running local copy + +To run local copy in development mode, execute: +```bash +gulp serve +``` +This script should automatically open template in your default browser. + +To run local copy in production mode, execute: +```bash +gulp serve:dist +``` +For addition information about build, please check out [this angular generator](https://github.com/Swiip/generator-gulp-angular) diff --git a/docs/contents/articles/011-changing-color-scheme/index.md b/docs/contents/articles/011-changing-color-scheme/index.md new file mode 100644 index 0000000..cc474bd --- /dev/null +++ b/docs/contents/articles/011-changing-color-scheme/index.md @@ -0,0 +1,50 @@ +--- +title: Changing Color Scheme +author: vl +sort: 900 +group: Customization +template: article.jade +--- + +If you want to change template color scheme, you just need to do 4 simple steps: + +1) Change color scheme in javascript (`src/app/theme/theme.constants.js`): +```javascript + // main color scheme + var colorScheme = { + primary: '#209e91', + info: '#2dacd1', + success: '#90b900', + warning: '#dfb81c', + danger: '#e85656', + }; + + // background color palette + var bgColorPalette = { + blueStone: '#005562', + surfieGreen: '#0e8174', + silverTree: '#6eba8c', + gossip: '#b9f2a1', + white: '#ffffff', + }; +``` +- css colors and javascript colors in colorScheme object should be the same +- background color palette is used for the pie traffic chart and calendar on the dashboard page + +2) Change colors in css (`src/sass/theme/conf/_colorScheme.scss`): + +```scss +$primary: #209e91 !default; +$info: #2dacd1 !default; +$success: #90b900 !default; +$warning: #dfb81c !default; +$danger: #e85656 !default; +``` + +3) Replace background images: `src/app/assets/img/blur-bg.jpg` and `src/app/assets/img/blur-bg-blurred.jpg` + +4) build source files and run application: `gulp` and `gulp serve` + +Below is an example of template with another color scheme: + +![](new-color-scheme.jpg) \ No newline at end of file diff --git a/docs/contents/articles/011-changing-color-scheme/new-color-scheme.jpg b/docs/contents/articles/011-changing-color-scheme/new-color-scheme.jpg new file mode 100644 index 0000000..e95600d Binary files /dev/null and b/docs/contents/articles/011-changing-color-scheme/new-color-scheme.jpg differ diff --git a/docs/contents/articles/012-project-structure/index.md b/docs/contents/articles/012-project-structure/index.md new file mode 100644 index 0000000..9077611 --- /dev/null +++ b/docs/contents/articles/012-project-structure/index.md @@ -0,0 +1,33 @@ +--- +title: Project Structure +author: vl +sort: 800 +group: Customization +template: article.jade +--- + +Project structure was originally based on [this angular generator](https://github.com/Swiip/generator-gulp-angular). We made some changes we thought would be better for our particular problem. + +The directory structure of this template is as follows: +``` +├── bower.json <- front-end library dependencies +├── gulpfile.js <- main task runner file +├── package.json <- mostly task runner dependencies +├── docs/ <- wintersmith documentation generator +├── gulp/ <- build tasks +├── src/ <- main front-end assets +│   ├── 404.html +│   ├── auth.html +│   ├── index.html <- main app dashboard page +│   ├── reg.html +│   ├── app/ <- angular application files +│   │   ├── app.js <- angular application entry point. Used for managing dependencies +│   │   ├── pages/ <- UI router pages. Pages created for demonstration purposes. Put your application js and html files here +│   │   ├── theme/ <- theme components. Contains various common widgets, panels which used across application +│   ├── assets/ <- static files (images, fonts etc.) +│   ├── sass/ <- sass styles +│   │   ├── app/ <- application styles. Used mostly for demonstration purposes. Put your app styles here. +│   │   ├── theme/ <- theme styles. Used to customize bootstrap and other common components used in tempate. +``` + +In our template we tried to separate theme layer and presentation layer. We believe most of other templates have them combined. That's why when you start developing using them, it gets very hard for you to remove things you don't need. Though we understand that our structure is not ideal, but we're aiming to make it as good as possible. diff --git a/docs/contents/articles/013-create-new-page/index.md b/docs/contents/articles/013-create-new-page/index.md new file mode 100644 index 0000000..104d016 --- /dev/null +++ b/docs/contents/articles/013-create-new-page/index.md @@ -0,0 +1,68 @@ +--- +title: Create New Page +author: vl +sort: 300 +group: Customization +template: article.jade +--- + +Blur admin uses [Angular UI router](https://github.com/angular-ui/ui-router) for navigation. +That means to create new page you need to basically configure `ui-router` state. + +We strongly recommend to follow pages structure in your application. +If it doesn't fit your needs please create a GitHub issue and tell us why. We would be glad to discuss. + +Also we recommend to put pages to separate modules. +This will allow you to easily switch off some pages in the future if needed. + +## Page creation example + +0) Let's assume we want to create a blank page with title 'My New Page' + +1) Let's Create a new directory to contain our new page inside of `src/app/pages`. Let's call this directory `myNewPage`. + +2) Then let's create blank angular module to contain our page called 'myNewPage.module.js' inside of `src/app/pages/myNewPage`: + +```javascript +(function () { + 'use strict'; + + angular.module('BlurAdmin.pages.myNewPage', []) + .config(routeConfig); + + /** @ngInject */ + function routeConfig() { + + } + +})(); +``` + +3) Then let's create empty html file called `my-new-page.html` inside of `src/app/pages/myNewPage`. + +4) Lastly let's create ui router state for this page. To do this we need to modify module.js file we created on step 2: +```javascript +(function () { + 'use strict'; + + angular.module('BlurAdmin.pages.myNewPage', []) + .config(routeConfig); + + /** @ngInject */ + function routeConfig($stateProvider) { + $stateProvider + .state('myNewPage', { + url: '/myNewPage', + templateUrl: 'app/pages/myNewPage/my-new-page.html', + title: 'My New Page', + sidebarMeta: { + order: 800, + }, + }); + } + +})(); +``` + +That's it! Your can now open your new page either from sidebar or through hash URL. + diff --git a/docs/contents/articles/051-sidebar/index.md b/docs/contents/articles/051-sidebar/index.md new file mode 100644 index 0000000..5a82b32 --- /dev/null +++ b/docs/contents/articles/051-sidebar/index.md @@ -0,0 +1,132 @@ +--- +title: Sidebar +author: vl +sort: 900 +group: Components +template: article.jade +--- + +Sidebar is used to provide convenient way of navigation in the application. +Application support only one sidebar per angular application. +That means sidebar is basically a singletone object. +Currently sidebar supports level 1 and 2 sub menus. + +Sidebar can be created using `baSidebar` directive: +```html + +``` + +For now it support only javascript configuration. Though it can be configured manually or via `ui-router` states. +This methods can be used either together or one at a time. + + +## Manual configuration + +For manual configuration you need to use `baSidebarServiceProvider` provider in angular [configuration block](https://docs.angularjs.org/guide/module#configuration-blocks). +The provider has `addStaticItem` method, which receives menuItem object as an argument, which can have following properties: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
propertytypemeaning
titleStringName of the menu item
iconStringIcon (it's a class name) to be displayed near title
stateRefString`ui-router` state associated with this menu item
fixedHrefStringUrl associated with this menu item
blankStringSpecifies if following Url should be opened in new browser tab
subMenuArray of menu itemsList of menu items to be displayed as next level submenu
+ +Sample manual configuration: +```javascript + baSidebarServiceProvider.addStaticItem({ + title: 'Menu Level 1', + icon: 'ion-ios-more' + }); +``` + +## Route configuration + +By default sidebar iterates through all **ui-router** states you defined in your application and searches for `sidebarMeta` object in them. +For each state, which has this property, sidebar element is created. + +States are being grouped hierarchically. +That means if there's a parent abstract state for some state and they both have `sidebarMeta` property, it will be displayed as a sub item of that abstract state's menu item. + +Name of the item is taken from `state`'s `title` property. Sample state configuration, which will add an item to sidebar: +```javascript +$stateProvider + .state('dashboard', { + url: '/dashboard', + templateUrl: 'app/pages/dashboard/dashboard.html', + title: 'Dashboard', + sidebarMeta: { + icon: 'ion-android-home', + order: 0, + }, + }); +``` + +`sidebarMeta` object can have following properties: + + + + + + + + + + + + + + + + + + + + + + + + +
propertytypemeaning
iconStringIcon (it's a class name) to be displayed near title
orderNumberElement's order in current hierarchy
\ No newline at end of file diff --git a/docs/contents/css/main.css b/docs/contents/css/main.css new file mode 100644 index 0000000..824a791 --- /dev/null +++ b/docs/contents/css/main.css @@ -0,0 +1,961 @@ +html { + font-family: 'Source Sans Pro', sans-serif; + color: #484848; + line-height: 1.28 +} + +p { + margin: 0 0 10px +} + +.subHeader { + font-size: 21px; + font-weight: 200; + line-height: 30px; + margin-bottom: 10px +} + +em { + font-style: italic +} + +h1, h2, h3, h4, h5, h6 { + margin: 10px 0; + font-family: inherit; + font-weight: bold; + line-height: 20px; + color: inherit; + text-rendering: optimizelegibility +} + +h1 small, h2 small, h3 small, h4 small, h5 small, h6 small { + font-weight: normal; + color: #7b7b7b +} + +h1, h2, h3 { + line-height: 40px +} + +h1 { + font-size: 39px +} + +h2 { + font-size: 31px +} + +h3 { + font-size: 23px +} + +h4 { + font-size: 16px +} + +h5 { + font-size: 14px +} + +h6 { + font-size: 11px +} + +h1 small { + font-size: 24px +} + +h2 small { + font-size: 18px +} + +h3 small { + font-size: 16px +} + +h4 small { + font-size: 14px +} + +ul, ol { + margin: 0 0 10px 25px; + padding: 0 +} + +ul ul, ul ol, ol ol, ol ul { + margin-bottom: 0 +} + +li { + line-height: 20px +} + +a { + color: #c05b4d; + text-decoration: none +} + +a:hover, a:focus { + color: #a5473a; + text-decoration: underline +} + +a:focus { + outline: thin dotted #333; + outline: 5px auto -webkit-focus-ring-color; + outline-offset: -2px +} + +.center { + text-align: center +} + +html * { + color-profile: sRGB; + rendering-intent: auto +} + +* { + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; + border: none; + margin: 0; + padding: 0 +} + +html { + background: #f9f9f9 +} + +.left { + float: left +} + +.right { + float: right +} + +.container { + padding-top: 50px; + min-width: 960px +} + +.wrap { + width: 960px; + margin-left: auto; + margin-right: auto; + padding-left: 20px; + padding-right: 20px +} + +.skinnyWrap { + width: 690px; + margin-left: auto; + margin-right: auto; + padding-left: 20px; + padding-right: 20px +} + +hr { + height: 0; + border-top: 1px solid #ccc; + border-bottom: 1px solid #eee +} + +ul, li { + margin-left: 20px +} + +li + li { + margin-top: 10px +} + +h1 .anchor, h2 .anchor, h3 .anchor, h4 .anchor, h5 .anchor, h6 .anchor { + margin-top: -50px; + position: absolute +} + +h1:hover .hash-link, h2:hover .hash-link, h3:hover .hash-link, h4:hover .hash-link, h5:hover .hash-link, h6:hover .hash-link { + display: inline +} + +.hash-link { + color: #aaa; + display: none +} + +.nav-main { + background: #222; + color: #fafafa; + position: fixed; + top: 0; + height: 50px; + box-shadow: 0 0 5px rgba(0, 0, 0, 0.5); + width: 100%; + z-index: 100 +} + +.nav-main:after { + content: ""; + display: table; + clear: both +} + +.nav-main a { + color: #e9e9e9; + text-decoration: none +} + +.nav-main .nav-site-internal { + margin: 0 0 0 20px +} + +.nav-main .nav-site-external { + float: right; + margin: 0 +} + +.nav-main .nav-site li { + margin: 0 +} + +.nav-main .nav-site li > a { + box-sizing: content-box; + padding: 0 10px; + line-height: 50px; + display: inline-block; + height: 50px; + color: #ddd +} + +.nav-main .nav-site li > a:hover { + color: #fff +} + +.nav-main .nav-site li > a.active { + color: #fafafa; + border-bottom: 3px solid #cc7a6f; + background: #333 +} + +.nav-main .nav-home { + color: #ffffff; + font-size: 24px; + line-height: 50px; + height: 50px; + display: inline-block +} + +.nav-main .nav-home .blur-label { + color: #209e91; +} + +.nav-main .nav-logo { + vertical-align: middle; + display: inline-block +} + +.nav-main ul { + display: inline-block; + vertical-align: top +} + +.nav-main li { + display: inline +} + +.hero { + padding-bottom: 75px; +} + +.hero .hero-content { + color: #e9e9e9; + font-weight: 300; + background: #313131; + padding-top: 50px; +} + +.hero .text { + font-size: 64px; + text-align: center +} + +.hero .minitext { + font-size: 16px; + text-align: center; + text-transform: uppercase +} + +.hero strong { + color: #209e91; + font-weight: 400 +} + +.white-text { + color: rgb(249, 249, 249); +} + +.hero .admin-screenshots { + margin-top: 40px; + display: flex; + flex-direction: row; +} + +.hero .admin-screenshot { + width: 50%; + padding: 0 15px; + text-align: center; + height: 250px; +} + +.admin-screenshot img { + width: 100%; +} + +.demo-link { + display: block; + position: relative; + line-height: 0; +} + +.demo-link:before { + content: ''; + position: absolute; + width: 100%; + bottom: 0; + left: 0; + height: 52px; + background-image: linear-gradient(to bottom, transparent, rgb(249,259,249)); +} + +.demo-link .demo-link-label { + display: flex; + align-items: center; + justify-content: center; + content: 'Demo'; + position: absolute; + top: 0; + left: 0; + width: 100%; + height: 100%; + background: rgba(0,0,0,0.5); + color: rgb(249, 249, 249); + font-size: 32px; + opacity: 0; + transition: opacity 0.3s ease-out; +} + +.demo-link:hover .demo-link-label { + opacity: 1; +} + +.buttons-unit { + margin-top: 60px; + text-align: center +} + +.buttons-unit a { + color: #61dafb +} + +.buttons-unit .button { + font-size: 24px; + background: #cc7a6f; + color: #fafafa +} + +.buttons-unit .button:active { + background: #c5695c +} + +.buttons-unit.downloads { + margin: 30px 0 +} + +.index-block { + padding:40px 0; +} + +.index-block h1 { + text-align: center; +} + +.index-block.black { + background: #313131; + color: #e9e9e9; +} + +.why-items { + display: flex; + flex-direction: row; + align-items: baseline; + margin-top: 15px; + padding-top: 15px; +} + +.why-item { + flex: 33%; + text-align: center; + padding: 0 15px; +} + +.why-item img { + width: 110px; +} + +.nav-docs { + color: #2d2d2d; + font-size: 14px; + float: left; + width: 210px +} + +.nav-docs ul { + list-style: none; + margin: 0 +} + +.nav-docs ul ul { + margin: 6px 0 0 20px +} + +.nav-docs li { + line-height: 16px; + margin: 0 0 6px +} + +.nav-docs h3 { + text-transform: uppercase; + font-size: 14px +} + +.nav-docs a { + color: #666; + display: block +} + +.nav-docs a:hover { + text-decoration: none; + color: #cc7a6f +} + +.nav-docs a.active { + color: #cc7a6f +} + +.nav-docs a.external:after { + content: ""; + display: inline-block; + width: 10px; + height: 10px; + padding-left: 5px; + background-image: url("../img/external.png"); + background-position: 100% 0; + background-repeat: no-repeat; + font-size: 10px; + line-height: 1em; + opacity: 0.5 +} + +@media only screen and (-webkit-min-device-pixel-ratio: 1.3), only screen and (min--moz-device-pixel-ratio: 1.3), only screen and (-o-min-device-pixel-ratio: 1.3 / 1), only screen and (min-resolution: 125dpi), only screen and (min-resolution: 1.3dppx) { + .nav-docs a.external:after { + background-image: url("../img/external_2x.png"); + background-size: 10px 10px + } +} + +.nav-docs .nav-docs-section { + border-bottom: 1px solid #ccc; + border-top: 1px solid #eee; + padding: 12px 0 +} + +.nav-docs .nav-docs-section:first-child { + padding-top: 0; + border-top: 0 +} + +.nav-docs .nav-docs-section:last-child { + padding-bottom: 0; + border-bottom: 0 +} + +.nav-blog li { + margin-bottom: 5px +} + +.nav-docs-right { + display: block; + float: right; + line-height: 50px; +} + +.nav-docs-right a { + color: #c05b4d; + text-decoration: none; +} + +.nav-docs-right a:hover { + text-decoration: underline; +} + +.home-section { + margin: 50px 0 +} + +.home-divider { + border-top-color: #bbb; + margin: 0 auto; + width: 400px +} + +.skinny-row:after { + content: ""; + display: table; + clear: both +} + +.skinny-col { + float: left; + margin-left: 40px; + width: 305px +} + +.skinny-col:first-child { + margin-left: 0 +} + +.marketing-row { + margin: 50px 0 +} + +.marketing-row:after { + content: ""; + display: table; + clear: both +} + +.marketing-col { + float: left; + margin-left: 40px; + width: 280px +} + +.marketing-col h3 { + color: #2d2d2d; + font-size: 24px; + font-weight: normal; + text-transform: uppercase +} + +.marketing-col p { + font-size: 16px +} + +.marketing-col:first-child { + margin-left: 0 +} + +#examples h3, .home-presentation h3 { + color: #2d2d2d; + font-size: 24px; + font-weight: normal; + margin-bottom: 5px +} + +#examples p { + margin: 0 0 25px 0; + max-width: 600px +} + +#examples .example { + margin-top: 60px +} + +#examples #todoExample { + font-size: 14px +} + +#examples #todoExample ul { + list-style-type: square; + margin: 0 0 10px 0 +} + +#examples #todoExample input { + border: 1px solid #ccc; + font: 14px proxima-nova, "Helvetica Neue", Helvetica, Roboto, Arial, sans-serif; + padding: 3px; + width: 150px +} + +#examples #todoExample button { + font: 14px proxima-nova, "Helvetica Neue", Helvetica, Roboto, Arial, sans-serif; + margin-left: 5px; + padding: 4px 10px +} + +#examples #markdownExample textarea { + border: 1px solid #ccc; + font: 14px proxima-nova, "Helvetica Neue", Helvetica, Roboto, Arial, sans-serif; + margin-bottom: 10px; + padding: 5px +} + +.home-bottom-section { + margin-bottom: 100px +} + +.docs-nextprev:after { + content: ""; + display: table; + clear: both +} + +.jsxCompiler { + margin: 0 auto; + padding-top: 20px; + width: 1220px +} + +.jsxCompiler label.compiler-option { + display: block; + margin-top: 5px +} + +.jsxCompiler #jsxCompiler { + margin-top: 20px +} + +.jsxCompiler .playgroundPreview { + padding: 0; + width: 600px; + word-wrap: break-word +} + +.jsxCompiler .playgroundPreview pre { + font-family: 'source-code-pro', Menlo, Consolas, 'Courier New', monospace; + font-size: 13px; + line-height: 1.5 +} + +.jsxCompiler .playgroundError { + padding: 15px 20px +} + +.docs-prev { + float: left +} + +.docs-next { + float: right +} + +footer { + font-size: 13px; + font-weight: 600; + margin-top: 36px; + margin-bottom: 18px; + overflow: auto +} + +section.black content { + padding-bottom: 18px +} + +.blogContent { + padding-top: 20px +} + +.blogContent:after { + content: ""; + display: table; + clear: both +} + +.blogContent blockquote { + padding: 5px 15px; + margin: 20px 0; + background-color: #f8f5ec; + border-left: 5px solid #f7ebc6 +} + +.blogContent h2 > code { + font-size: inherit; + line-height: inherit; + color: #555; + background-color: rgba(0, 0, 0, 0.04) +} + +.documentationContent { + padding-top: 20px +} + +.documentationContent:after { + content: ""; + display: table; + clear: both +} + +.documentationContent .subHeader { + font-size: 24px +} + +.documentationContent h2 { + margin-top: 30px +} + +.documentationContent blockquote { + padding: 15px 30px 15px 15px; + margin: 20px 0; + background-color: rgba(204, 122, 111, 0.1); + border-left: 5px solid rgba(191, 87, 73, 0.2) +} + +.documentationContent blockquote h4 { + margin-top: 0 +} + +.documentationContent blockquote p { + margin-bottom: 0 +} + +.documentationContent blockquote p:first-child { + font-weight: bold; + font-size: 17.5px; + line-height: 20px; + margin-top: 0; + text-rendering: optimizelegibility +} + +.docs-prevnext { + padding-top: 40px; + padding-bottom: 40px +} + +.button { + background: -webkit-linear-gradient(#9a9a9a, #646464); + background: linear-gradient(#9a9a9a, #646464); + border-radius: 4px; + padding: 8px 16px; + font-size: 18px; + font-weight: 400; + margin: 0 12px; + display: inline-block; + color: #fafafa; + text-decoration: none; + text-shadow: 0 1px 3px rgba(0, 0, 0, 0.3); + box-shadow: 0 1px 1px rgba(0, 0, 0, 0.2); + text-decoration: none +} + +.button:hover { + text-decoration: none +} + +.button:active { + box-shadow: none +} + +.hero .button { + box-shadow: 1px 3px 3px rgba(0, 0, 0, 0.3) +} + +.button.blue { + background: -webkit-linear-gradient(#77a3d2, #4783c2); + background: linear-gradient(#77a3d2, #4783c2) +} + +.row { + padding-bottom: 4px +} + +.row .span4 { + width: 33.33%; + display: table-cell +} + +.row .span8 { + width: 66.66%; + display: table-cell +} + +.row .span6 { + width: 50%; + display: table-cell +} + +p { + margin: 10px 0 +} + +.highlight { + padding: 10px; + margin-bottom: 20px +} + +figure { + text-align: center +} + +.inner-content { + float: right; + width: 650px +} + +.nosidebar .inner-content { + float: none; + margin: 0 auto +} + +.inner-content img { + max-width: 100%; +} + +.inner-content table { + border-collapse: collapse; + width: 100%; +} +.inner-content th, .inner-content td { + padding: 0.25rem; + text-align: left; + border: 1px solid #ccc; +} +.inner-content tbody tr:nth-child(odd) { + background: #eee; +} + +h1:after { + content: ""; + display: table; + clear: both +} + +.edit-page-link { + float: right; + font-size: 16px; + font-weight: normal; + line-height: 20px; + margin-top: 17px +} + +.post-list-item + .post-list-item { + margin-top: 60px +} + +/* code styling */ + +code { + font-family: 'Anonymous Pro', sans-serif; + font-size: 0.85em; + color: #000; +} + +pre code { + display: block; + line-height: 1.1; + color: #333333; + background: #f8f5ec; + padding: 30px 14px 14px; + position: relative; + overflow-x: auto; +} + +pre code:before { + position: absolute; + top: 0; + right: 0; + left: 0; + padding: 3px 7px; + font-size: 12px; + font-weight: bold; + color: #c2c0bc; + background-color: #f1ede4; + content: "Code"; +} + +p code { + padding: 0.1em 0.3em 0.2em; + border-radius: 0.3em; + position: relative; + background: #fffff3; + + white-space: nowrap; +} + +/* syntax hl stuff */ + +code.lang-markdown { + color: #424242; +} + +code.lang-markdown .header, +code.lang-markdown .strong { + font-weight: bold; +} + +code.lang-markdown .emphasis { + font-style: italic; +} + +code.lang-markdown .horizontal_rule, +code.lang-markdown .link_label, +code.lang-markdown .code, +code.lang-markdown .header, +code.lang-markdown .link_url { + color: #555; +} + +code.lang-markdown .blockquote, +code.lang-markdown .bullet { + color: #bbb; +} + +/* Tomorrow Theme */ +/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */ +/* Original theme - https://github.com/chriskempson/tomorrow-theme */ +/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */ +.tomorrow-comment, pre .comment, pre .title { + color: #8e908c; +} + +.tomorrow-red, pre .variable, pre .attribute, pre .tag, pre .regexp, pre .ruby .constant, pre .xml .tag .title, pre .xml .pi, pre .xml .doctype, pre .html .doctype, pre .css .id, pre .css .class, pre .css .pseudo { + color: #c82829; +} + +.tomorrow-orange, pre .number, pre .preprocessor, pre .built_in, pre .literal, pre .params, pre .constant { + color: #f5871f; +} + +.tomorrow-yellow, pre .class, pre .ruby .class .title, pre .css .rules .attribute { + color: #eab700; +} + +.tomorrow-green, pre .string, pre .value, pre .inheritance, pre .header, pre .ruby .symbol, pre .xml .cdata { + color: #718c00; +} + +.tomorrow-aqua, pre .css .hexcolor { + color: #3e999f; +} + +.tomorrow-blue, pre .function, pre .python .decorator, pre .python .title, pre .ruby .function .title, pre .ruby .title .keyword, pre .perl .sub, pre .javascript .title, pre .coffeescript .title { + color: #4271ae; +} + +.tomorrow-purple, pre .keyword, pre .javascript .function { + color: #8959a8; +} + +/* media queries */ + + +@media screen and (max-width: 960px) { + .nav-main { + position: static + } + + .container { + padding-top: 0 + } +} \ No newline at end of file diff --git a/docs/contents/images/blur-admin-logo.png b/docs/contents/images/blur-admin-logo.png new file mode 100644 index 0000000..963504f Binary files /dev/null and b/docs/contents/images/blur-admin-logo.png differ diff --git a/docs/contents/images/blur-preview-mint.jpg b/docs/contents/images/blur-preview-mint.jpg new file mode 100644 index 0000000..9967997 Binary files /dev/null and b/docs/contents/images/blur-preview-mint.jpg differ diff --git a/docs/contents/images/blur-preview.jpg b/docs/contents/images/blur-preview.jpg new file mode 100644 index 0000000..bdd78ae Binary files /dev/null and b/docs/contents/images/blur-preview.jpg differ diff --git a/docs/contents/images/favicon.png b/docs/contents/images/favicon.png new file mode 100644 index 0000000..25606ff Binary files /dev/null and b/docs/contents/images/favicon.png differ diff --git a/docs/contents/images/why-design.svg b/docs/contents/images/why-design.svg new file mode 100644 index 0000000..0f48642 --- /dev/null +++ b/docs/contents/images/why-design.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/contents/images/why-practices.svg b/docs/contents/images/why-practices.svg new file mode 100644 index 0000000..3e4d1f3 --- /dev/null +++ b/docs/contents/images/why-practices.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/contents/images/why-structure.svg b/docs/contents/images/why-structure.svg new file mode 100644 index 0000000..5b8f572 --- /dev/null +++ b/docs/contents/images/why-structure.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/contents/index.json b/docs/contents/index.json new file mode 100644 index 0000000..7991fa9 --- /dev/null +++ b/docs/contents/index.json @@ -0,0 +1,4 @@ +{ + "template": "index.jade", + "activeHome": true +} diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 0000000..f7ff426 --- /dev/null +++ b/docs/package.json @@ -0,0 +1,8 @@ +{ + "dependencies": { + "moment": "2.3.x", + "underscore": "1.4.x", + "typogr": "0.5.x" + }, + "private": "true" +} diff --git a/docs/plugins/paginator.coffee b/docs/plugins/paginator.coffee new file mode 100644 index 0000000..be6aa6b --- /dev/null +++ b/docs/plugins/paginator.coffee @@ -0,0 +1,44 @@ + +module.exports = (env, callback) -> + ### Paginator plugin. Defaults can be overridden in config.json + e.g. "paginator": {"perPage": 10} ### + + defaults = + template: 'index.jade' # template that renders pages + articles: 'articles' # directory containing contents to paginate + first: 'index.html' # filename/url for first page + filename: 'page/%d/index.html' # filename for rest of pages + perPage: 2 # number of articles per page + groupSort: {} + + # assign defaults any option not set in the config file + options = env.config.paginator or {} + for key, value of defaults + options[key] ?= defaults[key] + + getArticles = (contents) -> + # helper that returns a list of articles found in *contents* + # note that each article is assumed to have its own directory in the articles directory + articles = contents[options.articles]._.directories.map (item) -> item.index + # skip articles that does not have a template associated + articles = articles.filter (item) -> item.template isnt 'none' + # sort article by date + articles.sort (a, b) -> b.metadata.sort - a.metadata.sort + groupedArticlesObj = articles.reduce (acc, curr) -> + groupName = curr.metadata.group + if not acc[groupName] + acc[groupName] = + groupName: groupName + items: [] + acc[groupName].items.push curr + return acc + , {} + groupedArticles = (val for key, val of groupedArticlesObj) + groupedArticles.sort (a, b) -> (options.groupSort[b.groupName] || 0) - (options.groupSort[a.groupName] || 0) + return groupedArticles + + # add the article helper to the environment so we can use it later + env.helpers.getGroupedArticles = getArticles + + # tell the plugin manager we are done + callback() diff --git a/docs/templates/article.jade b/docs/templates/article.jade new file mode 100644 index 0000000..e174fc1 --- /dev/null +++ b/docs/templates/article.jade @@ -0,0 +1,21 @@ + +extends layout + +block title + | BlurAdmin documentation - #{page.title] + +block content + section.content.wrap.documentationContent + div.nav-docs + each group in groupedArticles + div.nav-docs.section + h3=group.groupName + ul + each article in group.items + li + a(href=article.url)(class= locals.page === article ? 'active': '')= article.title + div.inner-content + h1=locals.page.title + div.subHeader + != typogr(page.html).typogrify() + diff --git a/docs/templates/index.jade b/docs/templates/index.jade new file mode 100644 index 0000000..508a9e2 --- /dev/null +++ b/docs/templates/index.jade @@ -0,0 +1,69 @@ + +extends layout + +block title + | BlurAdmin angular admin dashboard template + +block content + div.hero + div.hero-content + div.wrap + div.text + strong Blur#[span.white-text Admin] + div.minitext Angular admin dashboard front-end framework + div.buttons-unit + a.button(href=installationArticleUrl) Installation guidelines + a.button(href=firstArticleUrl) Documentation + div.admin-screenshots + div.admin-screenshot + h3 Mint version + a.demo-link(href='http://akveo.com/blur-admin-mint/',target='_blank') + img(src=contents.images['blur-preview-mint.jpg'].url) + span.demo-link-label Demo + div.admin-screenshot + h3 Blur version (experimental) + a.demo-link(href='http://akveo.com/blur-admin/',target='_blank') + img(src=contents.images['blur-preview.jpg'].url) + span.demo-link-label Demo + div.index-block + div.wrap + h1 Why BlurAdmin? + div.why-items + div.why-item + img(src=contents.images['why-structure.svg'].url) + h4 Awesome structure + p Feature-based structure has proven itself as a good choice for large angular applications. + div.why-item + img(src=contents.images['why-design.svg'].url) + h4 Neat design + p We have carefully selected each color and character for this template. Enjoy it! + div.why-item + img(src=contents.images['why-practices.svg'].url) + h4 Ease of customization + p Check out our article, where we describe how can you create completely different look in 2 minutes! + div.index-block.black + div.wrap + h1 Is it free? + p Blur admin is completely free and MIT licensed. That means you can do whatever you want with it. + p + | Initially we planned to sell it on template markets. + | But they #[a(href='http://akveo.com/blog/why-i-hate-template-markets/',target='_blank') rejected us several times]. + | That's why we decided to make it open-source. And honestly, we have completely no regrets about it! + | And we suggest you to not waste your money and use our template instead of paid ones! + | Trust us, it's better than large number of them. + div.index-block + div.wrap + h1 How can I support you guys? + p Here's what you can do: + ul + li Star #[a(href='https://github.com/akveo/blur-admin',target='_blank') our GitHub repo] + li Create pull requests, submit bugs, suggest new features + li Follow #[a(href='https://twitter.com/akveo_inc',target='_blank') us on Twitter] + li Like #[a(href='https://www.facebook.com/akveo/',target='_blank') our page on Facebook] + div.index-block.black + div.wrap + h1 Can I hire you? + p Yes! We are available for hire. Visit #[a(href='http://akveo.com',target='_blank') our homepage] + | or simply leave us a note to #[a(href='mailto:contact@akveo.com') contact@akveo.com]. + | We will be happy to work with you! + diff --git a/docs/templates/layout.jade b/docs/templates/layout.jade new file mode 100644 index 0000000..675dbde --- /dev/null +++ b/docs/templates/layout.jade @@ -0,0 +1,41 @@ +doctype html +block vars + - var bodyclass = null; + - var groupedArticles = env.helpers.getGroupedArticles(contents); + - var firstArticleUrl = groupedArticles[0].items[0].url + - var installationArticleUrl = groupedArticles[0].items[1].url +html(lang='en') + head + block head + meta(charset='utf-8') + meta(http-equiv='X-UA-Compatible', content='IE=edge,chrome=1') + meta(name='viewport', content='width=device-width') + meta(name='keywords', content='admin,dashboard,template,angular,bootstrap,blur,panel,html,css,javascript') + title + block title + = locals.name + link(rel='alternate', href=locals.url+'/feed.xml', type='application/rss+xml', title=locals.description) + link(rel='stylesheet', href='https://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900italic,900|Anonymous+Pro:400,700,400italic,700italic&subset=latin,greek,greek-ext,vietnamese,cyrillic-ext,latin-ext,cyrillic') + link(rel='stylesheet', href=contents.css['main.css'].url) + link(rel='shortcut icon', href=contents.images['favicon.png'].url) + body(class=bodyclass) + div.container + div.nav-main + div.wrap + a.nav-home(href=contents['index'].url) + img.nav-logo(src=contents.images['blur-admin-logo.png'].url, width=36,height=36) + | #[span.blur-label Blur]Admin + ul.nav-site.nav-site-internal + li + a(class= locals.page.metadata.activeHome ? 'active': '')(href=contents['index'].url) Home + li + a(class= !locals.page.metadata.activeHome ? 'active': '')(href=firstArticleUrl) Docs + span.nav-docs-right + | Need some help? Let us know! #[a(href='mailto:help@akveo.com') help@akveo.com] + block content + h2 Welcome to blur admin! + footer.wrap + div.left Powered by Angular, Bootsrap, Gulp and more... + div.right + | © 2015–2016 Akveo LLC
+ | Documentation licensed under #[a(href='https://creativecommons.org/licenses/by/4.0/') CC BY 4.0]. \ No newline at end of file diff --git a/gulp/docs.js b/gulp/docs.js new file mode 100644 index 0000000..5b5a503 --- /dev/null +++ b/gulp/docs.js @@ -0,0 +1,14 @@ +'use strict'; + +var gulp = require('gulp'); + +var $ = require('gulp-load-plugins')(); + +gulp.task('wintersmith-generate', $.shell.task([ + 'wintersmith build' +], { cwd: 'docs' })); + +gulp.task('deploy-docs', ['wintersmith-generate'], function() { + return gulp.src('./docs/build/**/*') + .pipe($.ghPages()); +}); \ No newline at end of file diff --git a/package.json b/package.json index e61119b..19ad7a1 100644 --- a/package.json +++ b/package.json @@ -2,51 +2,52 @@ "name": "blur_admin", "version": "1.1.1", "devDependencies": { + "browser-sync": "~2.9.11", + "browser-sync-spa": "~1.0.3", + "chalk": "~1.1.1", + "del": "~2.0.2", + "eslint-plugin-angular": "~0.12.0", "estraverse": "~4.1.0", "gulp": "~3.9.0", - "gulp-autoprefixer": "~3.0.2", + "gulp-angular-filesort": "~1.1.1", "gulp-angular-templatecache": "~1.8.0", - "del": "~2.0.2", - "lodash": "~3.10.1", - "gulp-minify-css": "~1.2.1", + "gulp-autoprefixer": "~3.0.2", + "gulp-eslint": "~1.0.0", "gulp-filter": "~3.0.1", "gulp-flatten": "~0.2.0", - "gulp-eslint": "~1.0.0", - "eslint-plugin-angular": "~0.12.0", + "gulp-gh-pages": "^0.5.4", + "gulp-inject": "~3.0.0", "gulp-load-plugins": "~0.10.0", - "gulp-size": "~2.0.0", - "gulp-uglify": "~1.4.1", - "gulp-useref": "~1.3.0", - "gulp-util": "~3.0.6", + "gulp-minify-css": "~1.2.1", + "gulp-minify-html": "~1.0.4", "gulp-ng-annotate": "~1.1.0", + "gulp-prompt": "^0.1.2", + "gulp-protractor": "~1.0.0", + "gulp-rename": "^1.2.2", "gulp-replace": "~0.5.4", - "gulp-rename": "~1.2.2", "gulp-rev": "~6.0.1", "gulp-rev-replace": "~0.4.2", - "gulp-minify-html": "~1.0.4", - "gulp-inject": "~3.0.0", - "gulp-protractor": "~1.0.0", - "gulp-sourcemaps": "~1.6.0", "gulp-sass": "~2.0.4", - "gulp-angular-filesort": "~1.1.1", - "main-bower-files": "~2.9.0", - "wiredep": "~2.2.2", + "gulp-shell": "^0.5.2", + "gulp-size": "~2.0.0", + "gulp-sourcemaps": "~1.6.0", + "gulp-uglify": "~1.4.1", + "gulp-useref": "~1.3.0", + "gulp-util": "~3.0.6", + "gulp-zip": "^3.0.2", + "http-proxy-middleware": "~0.9.0", "karma": "~0.13.10", - "karma-jasmine": "~0.3.6", - "karma-phantomjs-launcher": "~0.2.1", - "phantomjs": "~1.9.18", "karma-angular-filesort": "~1.0.0", "karma-coverage": "~0.5.2", + "karma-jasmine": "~0.3.6", "karma-ng-html2js-preprocessor": "~0.2.0", - "browser-sync": "~2.9.11", - "browser-sync-spa": "~1.0.3", - "http-proxy-middleware": "~0.9.0", - "chalk": "~1.1.1", + "karma-phantomjs-launcher": "~0.2.1", + "lodash": "~3.10.1", + "main-bower-files": "~2.9.0", + "phantomjs": "~1.9.18", "uglify-save-license": "~0.4.1", - "wrench": "~1.5.8", - "gulp-prompt": "^0.1.2", - "gulp-rename": "^1.2.2", - "gulp-zip": "^3.0.2" + "wiredep": "~2.2.2", + "wrench": "~1.5.8" }, "scripts": { "postinstall": "bower install"