{"id":22085932,"url":"https://github.com/caleorourke/unveil","last_synced_at":"2026-04-13T01:02:59.310Z","repository":{"id":83649796,"uuid":"52770953","full_name":"caleorourke/unveil","owner":"caleorourke","description":"One page template designed for hosting on Github Pages","archived":false,"fork":false,"pushed_at":"2021-11-02T04:27:45.000Z","size":10767,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"gh-pages","last_synced_at":"2025-01-29T05:26:26.131Z","etag":null,"topics":["github-page","grunt","html","javascript","jekyll","less","ruby"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":false,"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/caleorourke.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-29T06:58:52.000Z","updated_at":"2021-11-02T04:27:48.000Z","dependencies_parsed_at":"2023-04-24T18:02:44.666Z","dependency_job_id":null,"html_url":"https://github.com/caleorourke/unveil","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caleorourke%2Funveil","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caleorourke%2Funveil/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caleorourke%2Funveil/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caleorourke%2Funveil/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caleorourke","download_url":"https://codeload.github.com/caleorourke/unveil/tar.gz/refs/heads/gh-pages","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245175484,"owners_count":20572787,"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":["github-page","grunt","html","javascript","jekyll","less","ruby"],"created_at":"2024-12-01T01:17:11.138Z","updated_at":"2026-04-13T01:02:59.248Z","avatar_url":"https://github.com/caleorourke.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://travis-ci.org/caleorourke/unveil?branch=gh-pages\" target=\"_blank\"\u003e\u003cimg src=\"http://travis-ci.org/caleorourke/unveil.svg?branch=gh-pages\"\u003e\u003c/a\u003e\n\u003ca href=\"https://david-dm.org/caleorourke/unveil#info=devDependencies\" target=\"_blank\"\u003e\u003cimg src=\"https://david-dm.org/caleorourke/unveil/dev-status.svg?theme=shields.io\"\u003e\u003c/a\u003e\n\u003ca href=\"http://github.com/caleorourke/unveil/blob/gh-pages/LICENSE\" target=\"_blank\"\u003e\u003cimg src=\"http://img.shields.io/badge/License-MIT-blue.svg\" alt=\"MIT License\"\u003e\u003c/a\u003e\n\n## Introduction\nOne page template designed for hosting on [GitHub Pages](http://pages.github.com) and serving locally using [Jekyll](http://jekyllrb.com).\n\n## Prerequisites\nRequires the *minimum* versions of Node.js and Ruby below.\n\n* [Node.js 0.10.30](http://nodejs.org/download)\n* [Ruby 2.0](http://www.ruby-lang.org/en/installation)\n\nRun the commands below to determine if the versions are currently installed.\n\n~~~bash\n# each command returns a version number\n$ node --version\n$ ruby -v\n~~~\n\n## Installation\nClone from `gh-pages` on GitHub and go into its directory.\n\n~~~\n$ git clone -b gh-pages https://github.com/caleorourke/unveil.git\n$ cd unveil\n~~~\n\n### Grunt\n[Grunt](http://gruntjs.com) is scripted for installing Node and Ruby dependencies. You must install Grunt CLI, thought, first. Run the commands to install Grunt and dev dependencies for Node.js.\n\n~~~bash\n$ sudo npm install -g grunt-cli\n$ sudo npm install\n~~~\n\n### Jekyll\nGrunt is also scripted for installing Jekyll and other runtime dependencies.\n\n~~~bash\n$ grunt install\n~~~\n\n## Commands\nAside from scripted install types, Grunt includes a number of scripts to serve the site locally. Run any of these commands to initiate a task.\n\n* `$ grunt build`\n* `$ grunt install`\n* `$ grunt serve`\n* `$ grunt test`\n\n#### $ grunt build\n\n1. Bundles and minifies `*.less` files to `*.css`\n2. Bundles and minifies `*.js` files\n\n#### $ grunt install\n\n1. Updates RubyGems\n2. Runs `gem install github-pages`\n\n#### $ grunt serve\n\n1. Bundles and minifies `*.less` files to `*.css`\n2. Bundles and minifies `*.js` files\n3. Builds the site locally in the `_site` directory\n4. Starts a local environment on `http://localhost:4000`\n5. Regenerates a new `_site` directory whenever a file is modified (except `.less` and `.js` assets)\n\n\u003e Serve mode lasts forever. It will not timeout after a period of non-usage. In order to stop it, press `CTRL+C`.\n\n#### $ grunt test\n\n1. Builds the website locally in the `_site` directory\n2. Spits out any errors found during the build process\n\n## Updates\nDependencies for Node and Grunt are updated often by their original authors. To install the latest versions, browse the sections below.\n\n### Node.js\nRun `sudo npm update` to install the latest versions. Should this fail for any reason, run the commands to delete the original directory and build a new one.\n\n~~~bash\n$ sudo rm -r node_modules // deletes node_modules\n$ sudo npm install // builds node_modules again\n~~~\n\nIf a \"SyntaxError: Use of const in strict mode\" error occurs, run the commands.\n\n~~~bash\n$ sudo npm cache clean -f // clears NPM cache\n$ sudo npm install -g n // installs a little helper called \"n\"\n$ sudo n stable // installs latest stable Node.js\n~~~\n\n### Grunt\nRun `grunt install` to install the latest versions.\n\n## Customization\nA number of customization options are available.\n\n### Letter Animation\nAdjust the settings for the hero's letter animation under the `textillate_options` var in `js/textillate.js`.\n\n~~~js\nvar textillate_options = {\n  loop:           false,\n  minDisplayTime: 0,\n  initialDelay:   0,\n  autoStart:      false,\n  inEffects:      ['fadeIn'],\n  outEffects:     ['fadeOutDown'],\n  'in': {\n    effect:       'fadeIn',\n    delayScale:   1.5,\n    delay:        12,\n    sync:         false,\n    shuffle:      true,\n    reverse:      false\n  },\n  out: {\n    effect:       'fadeOutDown',\n    delayScale:   1.5,\n    delay:        8,\n    sync:         false,\n    shuffle:      true,\n    reverse:      false\n  }\n};\n~~~\n\n### Scroll Speed\nAdjust the settings for scroll speed under the `onePageNav` function in `js/options.js`.\n\n~~~js\n$('#nav').onePageNav({\n  currentClass:     'active',\n  changeHash:       false,\n  scrollSpeed:      750,\n  scrollThreshold:  0.5,\n  filter:           ':not(.contact)',\n  easing:           'swing',\n  begin:            function () {},\n  end:              function () {},\n  scrollChange:     function () {}\n});\n~~~\n\n## License\nCode and documentation licensed under the MIT license.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaleorourke%2Funveil","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaleorourke%2Funveil","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaleorourke%2Funveil/lists"}