https://github.com/keithmifsud/vagrant-jekyll
Vagrant environment for Jekyll and Gthub Pages Sites
https://github.com/keithmifsud/vagrant-jekyll
Last synced: 4 months ago
JSON representation
Vagrant environment for Jekyll and Gthub Pages Sites
- Host: GitHub
- URL: https://github.com/keithmifsud/vagrant-jekyll
- Owner: keithmifsud
- License: apache-2.0
- Created: 2016-06-22T13:34:39.000Z (about 9 years ago)
- Default Branch: develop
- Last Pushed: 2016-07-28T18:48:03.000Z (almost 9 years ago)
- Last Synced: 2025-01-09T01:11:51.480Z (6 months ago)
- Language: Ruby
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vagrant Jekyll - v0.2-dev
Vagrant environment for Jekyll and Github Pages Sites.
## Important Notes
**This repository is in initial stages of development.**
Feel free to use it, fork it, improve it and even contribute to it.
However, this is by far not final until version 1.0 is released. It is
imperative that you have prior experience and understanding of vagrant
until this repository is in a production and tested stage.
## Purpose
The purpose of this project is to satisfy my personal requirements to have an
easy setup for launching and maintaining github pages powered sites and blogs.
At the same time of developing this project, I'm working on a similar, yet
more inclusive project, hence, certain features may seem either a bit out of place or not in a logical structure. This is so they can both be adapted. The production release will be in a desired state and structure.
**Watch the repository**
I aim to develop something a lot better than this to assist in building,
maintaining and deploying github pages sites. If interested, then simply watch this repository or follow me for updates.
## Installation
**PLEASE DO NOT INSTALL OR USE AT THE MOMENT.**
@TODO Keith
Dependencies
Config
## Usage
**PLEASE DO NOT INSTALL OR USE AT THE MOMENT.**
@TODO Keith
## Licence & Copyright
This is a free software distributed under the terms of the Apache License 2.0.
Please read the [Licence](LICENSE) included with this source code.
**Copyright** (c) 2016 - Keith Mifsud ([email protected])
## Support & Releases
Semantic versioning is used, however, this is not applicable for any release
prior to version 1.0.
A changelog and upgrade guides will be supplied post the initial production release v1.0 if and when relevant.
Please report any issues you encounter on the [issues page](https://github.com/keithmifsud/vagrant-jekyll/issues).
*A HipChat or Slack chat room can be made available if needed*
## Contribution guidelines
**Your contributions are welcome and encouraged**
To contribute, fork the
[The main repository: https://github.com/keithmifsud/vagrant-jekyll](https://github.com/keithmifsud/vagrant-jekyll) and checkout a branch from the develop branch of your fork. Once ready, submit a
pull request to the main repository's **develop branch**.
The name of your branch should be named as the issue key of GitHub (GH-xx) or Jira (ID-KEY).
### Code Style
#### PHP
Please follow the PSR-2 coding style guidelines and PSR-4 directory structure
guidelines.
#### Bash
Please follow this
Shell Style Guide *opens in new window*
#### Ruby
Please follow this Ruby Style Guide *opens in new window*