Skip to content

winkjs/winkjs.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

winkjs.org

This the repo of for the wink.js website. It uses middleman a static website generator. You'll need the latest stable version of Ruby to run it. It is recommended that you use rvm to get the latest version of Ruby, and bundler to install gems and manage the environment.

Development

After cloning, you'll need to install dependencies using bundle install. Then run bundle exec middleman serve to start a preview web server. You can then navigate to http://localhost:4567/ too see the local website.

You can also run bundle exec middleman build to generate a build in the build/ directory. Note: this directory is ignored in .gitignore.

NOTE: All development for this repository happens in the dev branch. The master branch is only used for deployment. Do not push directly to master. Only push to dev.

See Middleman documentation for more details.

Adding a new wink package

To add a new package, add its name and description to data/packageinfo.json. The name should be without the wink- prefix. Then add the package to the list of packages in source/packages.html.erb.

Deploy

We are hosting this website using Github pages. Since this website is an Organization Pages site it must be deployed from the master branch. And so, the default branch has been set to dev.

Also, due to some compatibility issues we use a pre alpha version of middelman-deploy. Our deploy-method is git, and we push to master, where Middleman creates an automatic commit for deployment.

After you're happy with the changes in the dev branch you can run:

bundle exec middleman build
bundle exec middleman deploy

for Middleman to automatically build the website and push it to master.

About

New winkjs.org website, made using middleman

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published