Skip to content

Commit e27179d

Browse files
committed
Documentation theme changes
1 parent 3a03395 commit e27179d

File tree

5 files changed

+27
-4
lines changed

5 files changed

+27
-4
lines changed

.circleci/config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ jobs:
8181
- run:
8282
name: Install MkDocs
8383
command: sudo pip install mkdocs
84+
- run:
85+
name: Install MkDocs theme
86+
command: sudo pip install mkdocs-material
8487
- run:
8588
name: Avoid hosts unknown for github
8689
command: echo -e "Host github.com\n\tStrictHostKeyChecking no\n" > ~/.ssh/config

config/karma.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ module.exports = function (config) {
2626
type: 'in-memory'
2727
}
2828
config.remapCoverageReporter = {
29-
'text-summary': null,
29+
'text-summary': path.join(gulp_core_build.getConfig().tempFolder, 'coverage/coverage.txt'),
3030
html: path.join(gulp_core_build.getConfig().tempFolder, 'coverage/html'),
3131
cobertura: path.join(gulp_core_build.getConfig().tempFolder, 'coverage/cobertura.xml'),
32-
lcovonly: path.join(gulp_core_build.getConfig().tempFolder, 'coverage/coverage.txt')
32+
lcovonly: path.join(gulp_core_build.getConfig().tempFolder, 'coverage/coverage.info')
3333
};
3434
config.plugins.push(remapCoverageReporter);
3535
};
10.7 KB
Loading

docs/documentation/docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To get started you have to install the following dependency to your project: `@p
66

77
Enter the following command to install the dependency to your project:
88

9-
```
9+
```bash
1010
npm install @pnp/spfx-controls-react --save --save-exact
1111
```
1212

docs/documentation/mkdocs.yml

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,26 @@ pages:
1010
- About:
1111
- 'Release notes': 'about/release-notes.md'
1212
- License: 'about/license.md'
13-
theme: readthedocs
13+
theme:
14+
name: 'material'
15+
palette:
16+
primary: 'blue'
17+
logo: 'assets/sharepoint.png'
18+
feature:
19+
tabs: true
20+
markdown_extensions:
21+
- admonition
22+
- codehilite:
23+
guess_lang: false
24+
- toc:
25+
permalink: true
26+
extra:
27+
social:
28+
- type: 'twitter'
29+
link: 'https://twitter.com/officedevpnp'
30+
- type: 'youtube'
31+
link: 'http://aka.ms/sppnp-videos'
32+
- type: 'link'
33+
link: 'https://aka.ms/sppnp'
1434
repo_url: https://github.com/SharePoint/sp-dev-fx-controls-react
1535
edit_uri: blob/master/docs/documentation/docs

0 commit comments

Comments
 (0)