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

we need to show our GETTING_STARTED information easier by loading it in the docs site.
Teradata · Apr 12, 2017 · 6f089fa · 6f089fa
1 parent 193bc90
commit 6f089fa
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git a/.angular-cli.json b/.angular-cli.json
@@ -8,6 +8,7 @@
       "root": "src",
       "outDir": "dist",
       "assets": [
+        { "glob": "**/*", "input": "../docs", "output": "./docs/" },
         "app/assets",
         "platform",
         "favicon.ico"

diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md
@@ -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.
@@ -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.

diff --git a/src/app/components/docs/docs.module.ts b/src/app/components/docs/docs.module.ts
@@ -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';
 
@@ -34,6 +36,7 @@ import { CovalentHighlightModule } from '../../../platform/highlight';
   imports: [
     CovalentCoreModule,
     CovalentHighlightModule,
+    DocumentationToolsModule,
     docsRoutes,
   ],
 })

diff --git a/src/app/components/docs/overview/overview.component.html b/src/app/components/docs/overview/overview.component.html
@@ -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>
@@ -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">