This repository has been archived by the owner on May 8, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(documentation): Further documentation tweaks to layouts
- Loading branch information
Showing
13 changed files
with
140 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
layout: basic.html | ||
layout: basic.hbs | ||
------------------ | ||
|
||
# OOPS! Can't find that page | ||
# OOPS! Can't find that page |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: API | ||
date: 2016-05-29 | ||
collection: main | ||
layout: api-container.hbs | ||
------------------------- | ||
|
||
This contains the api output from typedoc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Developer Guide | ||
date: 2016-05-29 | ||
collection: main | ||
layout: guide-listing.hbs | ||
------------------------- | ||
|
||
Here is the guide document |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
title: Controllers | ||
date: 2016-06-01 | ||
collection: guide | ||
layout: guide.hbs | ||
----------------- | ||
|
||
### Example controller | ||
|
||
```typescript | ||
import { Injectable } from '@angular/core'; | ||
import { | ||
Server, | ||
RouteBase, | ||
AbstractController, | ||
Logger, | ||
Request, | ||
RouteParamMap, | ||
Action | ||
} from '@ubiquits/core/server'; | ||
import { AbstractModel, ModelStore } from '@ubiquits/core/common'; | ||
import { User } from '../../common/models/user.model'; | ||
import { UserStore } from '../stores/user.store'; | ||
@Injectable() | ||
@RouteBase('test') | ||
export class TestController extends AbstractController { | ||
constructor(server: Server, logger: Logger, protected userStore:UserStore) { | ||
super(server, logger); | ||
logger.info(`route base is ${this.routeBase}`); | ||
|
||
} | ||
|
||
|
||
@Action('GET', '/test-route') | ||
public test() { | ||
return 'hello world'; | ||
} | ||
|
||
protected getOneById(request: Request, routeParams: RouteParamMap): User { | ||
|
||
let user = this.userStore.findOne(routeParams.get('id')); | ||
this.logger.debug(user, user.getIdentifier()); | ||
|
||
return user; | ||
|
||
} | ||
|
||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
title: Database | ||
date: 2016-06-01 | ||
collection: guide | ||
layout: guide.hbs | ||
----------------- | ||
|
||
### Example database query | ||
|
||
```typescript | ||
import { Injectable } from '@angular/core'; | ||
import { | ||
Database, | ||
} from '@ubiquits/core/server'; | ||
@Injectable() | ||
export class ExampleUtil { | ||
constructor(database: Database, logger:Logger) { | ||
database.query('SELECT * FROM users').then((result) => { | ||
logger.debug(result); | ||
}): | ||
} | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,5 @@ | ||
--- | ||
layout: home.html | ||
----------------- | ||
layout: home.hbs | ||
---------------- | ||
|
||
## Test post listing! | ||
|
||
- [Test post](/posts/test-post/) | ||
- [@todo items for docs](/posts/documentation-todo/) | ||
## Welcome... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: News | ||
date: 2016-06-01 | ||
collection: main | ||
layout: news-listing.hbs | ||
------------------------ | ||
|
||
Here is the news listing |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Test Local layout post | ||
date: 2016-05-31 | ||
collection: news | ||
layout: test.hbs | ||
----------------- | ||
|
||
This tests the local layout option |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
<section><h3>This is a partial</h3></section> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{{> header }} | ||
|
||
{{> test }} | ||
|
||
{{{ contents }}} | ||
|
||
{{> footer }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters