Skip to content
This repository has been archived by the owner on May 8, 2020. It is now read-only.

Commit

Permalink
feat(documentation): added collection sorting, fallback for api, rena…
Browse files Browse the repository at this point in the history
…med package to include url, added quickstart, extracted home template from toolchain
  • Loading branch information
zakhenry committed Jun 2, 2016
1 parent 9340646 commit e1a955d
Show file tree
Hide file tree
Showing 11 changed files with 108 additions and 73 deletions.
9 changes: 7 additions & 2 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@
title: API
date: 2016-05-29
collection: main
collectionSort: 1
layout: api-container.hbs
-------------------------
---

This contains the api output from typedoc
## Error
Typedoc output not found. Have you run the generator?
```bash
$ u doc:api
```
1 change: 1 addition & 0 deletions docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Developer Guide
date: 2016-05-29
collection: main
collectionSort: 0
layout: guide-listing.hbs
-------------------------

Expand Down
6 changes: 6 additions & 0 deletions docs/guide/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ collection: guide
layout: guide.hbs
-----------------

## Intro

## Queries
### ORM
### Raw

### Example database query

```typescript
Expand Down
15 changes: 15 additions & 0 deletions docs/guide/quick-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Quick Start
date: 2016-06-02
collection: guide
layout: guide.hbs
-----------------

## Installation
```bash
git clone https://github.com/ubiquits/ubiquits.git \
&& rm -rf .git \
&& git init \
&& npm i \
&& u watch
```
4 changes: 1 addition & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
---
layout: home.hbs
----------------

## Welcome...
---
1 change: 1 addition & 0 deletions docs/news.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: News
date: 2016-06-01
collection: main
collectionSort: 2
layout: news-listing.hbs
------------------------

Expand Down
10 changes: 1 addition & 9 deletions docs/news/documentation-todo.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,8 @@ layout: post.hbs
-----------------
These are the items I would like to integrate into the documentation

- add logo.
- complete homepage.
- typedoc integration (use same templates??)
- travis ci auto deployments
- custom domain hosting from [ubiquits.com](http://ubiquits.com)
- integrate metalsmith addons to add
- [collections](https://github.com/segmentio/metalsmith-collections)
- [date formatter](https://github.com/hellatan/metalsmith-date-formatter)
- [gists](https://github.com/expalmer/metalsmith-gist)
- [headings](https://github.com/segmentio/metalsmith-headings)
- [navigation](https://github.com/unstoppablecarl/metalsmith-navigation)
- [less](https://github.com/christophercliff/metalsmith-less)
- [wordcount](https://github.com/majodev/metalsmith-word-count)
- [sass](https://www.npmjs.com/package/metalsmith-sass)
54 changes: 0 additions & 54 deletions docs/news/test-post.md

This file was deleted.

62 changes: 62 additions & 0 deletions docs/templates/home.hbs
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
{{> head }}
{{> header }}
<main>

<div id="index-banner" class="parallax-container">
<div class="section no-pad-bot">
<div class="container">
<br><br>
<h1 class="header center grey-text text-lighten-2">{{ title }}</h1>
<div class="row center">
<h5 class="header col s12 light">{{ description }}</h5>
</div>
<div class="row center">
<a href="http://materializecss.com/getting-started.html" id="download-button" class="btn-large waves-effect waves-light grey lighten-1">Get Started</a>
</div>
<br><br>

</div>
</div>
<div class="parallax"><img src="/assets/img/background1.jpg" alt="Unsplashed background img 1"></div>
</div>


<div class="container">
<div class="section">

<!-- Icon Section -->
<div class="row">
<div class="col s12 m4">
<div class="icon-block">
<h2 class="center brown-text"><i class="material-icons">flash_on</i></h2>
<h5 class="center">Speeds up development</h5>

<p class="light">We did most of the heavy lifting for you to provide a default stylings that incorporate our custom components. Additionally, we refined animations and transitions to provide a smoother experience for developers.</p>
</div>
</div>

<div class="col s12 m4">
<div class="icon-block">
<h2 class="center brown-text"><i class="material-icons">group</i></h2>
<h5 class="center">User Experience Focused</h5>

<p class="light">By utilizing elements and principles of Material Design, we were able to create a framework that incorporates components and animations that provide more feedback to users. Additionally, a single underlying responsive system across all platforms allow for a more unified user experience.</p>
</div>
</div>

<div class="col s12 m4">
<div class="icon-block">
<h2 class="center brown-text"><i class="material-icons">settings</i></h2>
<h5 class="center">Easy to work with</h5>

<p class="light">We have provided detailed documentation as well as specific code examples to help new users get started. We are also always open to feedback and can answer any questions a user may have about Materialize.</p>
</div>
</div>
</div>

</div>
</div>

</main>

{{> footer }}
11 changes: 8 additions & 3 deletions docs/templates/test.hbs
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
{{> head }}
{{> header }}

{{> test }}

{{{ contents }}}
<main>
<div class="container">
<h1>{{ title }}</h1>
<time>{{ date }}</time>
{{{ contents }}}
</div>
</main>

{{> footer }}
8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@
"keywords": [
"ubiquits"
],
"author": "Zak Henry",
"author": {
"name" : "Zak Henry",
"email" : "[email protected]",
"url" : "http://twitter.com/zak"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/ubiquits/core/issues"
Expand Down Expand Up @@ -51,4 +55,4 @@
"@ubiquits/toolchain": "0.0.8",
"greenkeeper-postpublish": "^1.0.0"
}
}
}

0 comments on commit e1a955d

Please sign in to comment.