Package Exports
- mdcss-theme-github
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mdcss-theme-github) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
mdcss GitHub
mdcss GitHub is a theme for mdcss based on the documentation styles seen across GitHub.
Usage
Add mdcss and mdcss GitHub to your build tool:
npm install mdcss --save-dev
npm install mdcss-theme-github --save-devWhenever mdcss is used, reference this theme.
require('mdcss')({
theme: require('mdcss-theme-github')({ /* options */ })
})Options
title
Type: String
Default: 'Style Guide'
The title to be used by the style guide.
template
Type: String
Default: 'main'
The template within the GitHub theme that you would like to use.
index
Type: String
Default: 'index.html'
The complete name of the main file that you would like generated inside the style guide directory.