Andreas/ngx-admin
1
0
Fork 0
mirror of https://github.com/akveo/ngx-admin.git synced 2026-03-03 20:30:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(general): create documentation structure

Browse source
This commit is contained in:
nixa 2016-05-23 12:13:30 +03:00
parent c66de4a295
commit 7a9b7fc750
23 changed files with 1620 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/templates/article.jade vendored Normal file
View file

@ -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()

69
docs/templates/index.jade vendored Normal file
View file

@ -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 panel 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 put a lot of efforts and carefully selected each color and character for this template!
div.why-item
img(src=contents.images['why-practices.svg'].url)
h4 Ease of customization
p Check out #[a(href='/blur-admin/articles/011-changing-color-scheme') our article], where we describe how you can create different look in just 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!

43
docs/templates/layout.jade vendored Normal file
View file

@ -0,0 +1,43 @@
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:contact@akveo.com') contact@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<br />
| Documentation licensed under #[a(href='https://creativecommons.org/licenses/by/4.0/') CC BY 4.0].
a(href='https://github.com/akveo/blur-admin')
img(style='position: fixed; top: 0; right: 0; border: 0; z-index: 1000;',src='https://camo.githubusercontent.com/365986a132ccd6a44c23a9169022c0b5c890c387/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67',alt='Fork me on GitHub',data-canonical-src='https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png')