{"id":21189224,"url":"https://github.com/uptick/uptick-demo-site","last_synced_at":"2025-03-14T20:42:23.345Z","repository":{"id":47807399,"uuid":"73981999","full_name":"uptick/uptick-demo-site","owner":"uptick","description":"Content for creating Uptick branded demo sites.","archived":false,"fork":false,"pushed_at":"2024-02-15T06:01:22.000Z","size":231,"stargazers_count":0,"open_issues_count":8,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-07T05:17:21.625Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/uptick.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-17T02:28:13.000Z","updated_at":"2024-02-15T03:15:24.000Z","dependencies_parsed_at":"2023-01-23T15:01:20.680Z","dependency_job_id":null,"html_url":"https://github.com/uptick/uptick-demo-site","commit_stats":null,"previous_names":["abasystems/abas-demo-site"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Fuptick-demo-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Fuptick-demo-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Fuptick-demo-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Fuptick-demo-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uptick","download_url":"https://codeload.github.com/uptick/uptick-demo-site/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243646524,"owners_count":20324582,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-20T18:50:47.835Z","updated_at":"2025-03-14T20:42:23.318Z","avatar_url":"https://github.com/uptick.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# uptick-demo-site\n\n[![npm version](https://badge.fury.io/js/uptick-demo-site.svg)](http://badge.fury.io/js/uptick-demo-site)\n![Downloads](http://img.shields.io/npm/dm/uptick-demo-site.svg?style=flat)\n\nContent for creating Uptick-branded demo sites, such as:\n\n- http://uptick.github.io/react-object-table/\n\nThe demo site framework contains all the styles, a base template to use with Jekyll, and some\ncommon Javascript widgets.\n\n## Installation\n\nDownload the package:\n\n```shell\nnpm install uptick-demo-site\n```\n\n### Styles\n\nEither import the styles in your preprocessed stylesheet:\n\n```scss\n@import \"node_modules/uptick-demo-site/dist/uptick-demo-site\";\n```\n\nOr host and include the built css directly:\n\n```html\n\u003clink href=\"/node_modules/uptick-demo-site/dist/uptick-demo-site.css\" rel=\"stylesheet\"\u003e\n```\n\n### Widgets\n\nInitialise the demo site components\n\n```javascript\nimport { init } from 'uptick-demo-site'\n\ninit()\n```\n\n### Base Template\n\nTo use the base template, you will need to replace the default Jekyll _layouts directory in your\nconfig with the dist folder of this package:\n\n```yml\n_config.yml\n\nlayouts_dir: 'node_modules/uptick-demo-site/dist'\n```\n\nThe base layout depends on the following templates existing in your Jekyll _includes folder:\n\n- head.html\n- required_static.html\n\n### Favicon\n\nCopy `favicon.png` from this project's source directory into your jekyll root folder. Then add to\nthe `jekyll-seo-tag` plugin to your project:\n\n```yml\n_config.yml\n\nplugins:\n  - jekyll-seo-tag\n```\n\n## Usage\n\n### Base Template Customisation\n\nA number of variables are used to customise the base template, which are set in your Jekyll config:\n\n```yml\n_config.yml\n\npackage_name: Cool Package\npackage_github_url: https://github.com/uptick/cool-package\npackage_npm_url: https://www.npmjs.com/package/cool-package\n```\n\n### Source Code Previewer\n\nTo implement a source code previewer, use the following HTML mount:\n\n```html\n\u003ccode\n  class=\"script\"\n  data-source=\"static/demo-script.jsx\"\n\u003eLoading ...\u003c/code\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuptick%2Fuptick-demo-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuptick%2Fuptick-demo-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuptick%2Fuptick-demo-site/lists"}