Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(getting-started): load our GETTING_STARTED.md in the docs (closes #504) #505

Merged
merged 3 commits into from
Apr 12, 2017
Merged

chore(getting-started): load our GETTING_STARTED.md in the docs (closes #504) #505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae6131c
chore(getting-started): load our GETTING_STARTED.md in the docs
Apr 12, 2017
dac2367
Merge branch 'develop' into feature/getting-started-docs
emoralesb05 Apr 12, 2017
0c8a68c
Merge branch 'develop' into feature/getting-started-docs
emoralesb05 Apr 12, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .angular-cli.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"root": "src",
"outDir": "dist",
"assets": [
{ "glob": "**/*", "input": "../docs", "output": "./docs/" },
"app/assets",
"platform",
"favicon.ico"
Expand Down
5 changes: 4 additions & 1 deletion docs/GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Getting Started

Get started with Covalent using the Angular CLI.

See the [material getting started](https://github.com/angular/material2/blob/master/guides/getting-started.md) for instructions.
Expand Down Expand Up @@ -113,7 +115,8 @@ or

If you're not using the Angular CLI, you can use any existing Sass tooling to build the file (such as gulp-sass or grunt-sass). The simplest approach is to use the node-sass CLI; you simply run:

node-sass src/themes.scss dist/themes.css
`node-sass src/themes.scss dist/themes.css`

and then include the output file in your application.

The theme file can be concatenated and minified with the rest of the application's css.
Expand Down
3 changes: 3 additions & 0 deletions src/app/components/docs/docs.module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ import { TestingComponent } from './testing/testing.component';
import { ThemeComponent } from './theme/theme.component';
import { MockDataComponent } from './mock-data/mock-data.component';

import { DocumentationToolsModule } from '../../documentation-tools';

import { CovalentCoreModule } from '../../../platform/core';
import { CovalentHighlightModule } from '../../../platform/highlight';

Expand All @@ -34,6 +36,7 @@ import { CovalentHighlightModule } from '../../../platform/highlight';
imports: [
CovalentCoreModule,
CovalentHighlightModule,
DocumentationToolsModule,
docsRoutes,
],
})
Expand Down
9 changes: 5 additions & 4 deletions src/app/components/docs/overview/overview.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<td-readme-loader resourceUrl="docs/GETTING_STARTED.md"></td-readme-loader>
<md-card>
<md-card-title>Getting Started</md-card-title>
<md-card-subtitle>Start using the Teradata UI Platform</md-card-subtitle>
<md-card-title>Quickstart Setup</md-card-title>
<md-card-subtitle>Start using the Covalent Quickstart</md-card-subtitle>
<md-divider></md-divider>
<md-card-content>
<h3>Covalent Quickstart</h3>
Expand Down Expand Up @@ -41,9 +42,9 @@ <h4>If you don't have the Angular CLI, install:</h4>
<td-highlight lang="bash">
npm i -g @angular/cli@latest
</td-highlight>
<h4>Install Typescript 2.0:</h4>
<h4>Install Typescript:</h4>
<td-highlight lang="bash">
npm install -g typescript@2.0.2
npm install -g typescript
</td-highlight>
<h4>To install Protractor & TSLint for testing:</h4>
<td-highlight lang="bash">
Expand Down