https://github.com/uptick/uptick-demo-site
Content for creating Uptick branded demo sites.
https://github.com/uptick/uptick-demo-site
Last synced: about 1 year ago
JSON representation
Content for creating Uptick branded demo sites.
- Host: GitHub
- URL: https://github.com/uptick/uptick-demo-site
- Owner: uptick
- License: mit
- Created: 2016-11-17T02:28:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-15T06:01:22.000Z (over 2 years ago)
- Last Synced: 2025-03-07T05:17:21.625Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 226 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# uptick-demo-site
[](http://badge.fury.io/js/uptick-demo-site)
Content for creating Uptick-branded demo sites, such as:
- http://uptick.github.io/react-object-table/
The demo site framework contains all the styles, a base template to use with Jekyll, and some
common Javascript widgets.
## Installation
Download the package:
```shell
npm install uptick-demo-site
```
### Styles
Either import the styles in your preprocessed stylesheet:
```scss
@import "node_modules/uptick-demo-site/dist/uptick-demo-site";
```
Or host and include the built css directly:
```html
```
### Widgets
Initialise the demo site components
```javascript
import { init } from 'uptick-demo-site'
init()
```
### Base Template
To use the base template, you will need to replace the default Jekyll _layouts directory in your
config with the dist folder of this package:
```yml
_config.yml
layouts_dir: 'node_modules/uptick-demo-site/dist'
```
The base layout depends on the following templates existing in your Jekyll _includes folder:
- head.html
- required_static.html
### Favicon
Copy `favicon.png` from this project's source directory into your jekyll root folder. Then add to
the `jekyll-seo-tag` plugin to your project:
```yml
_config.yml
plugins:
- jekyll-seo-tag
```
## Usage
### Base Template Customisation
A number of variables are used to customise the base template, which are set in your Jekyll config:
```yml
_config.yml
package_name: Cool Package
package_github_url: https://github.com/uptick/cool-package
package_npm_url: https://www.npmjs.com/package/cool-package
```
### Source Code Previewer
To implement a source code previewer, use the following HTML mount:
```html
Loading ...
```