Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 2.52 KB

README.md

File metadata and controls

30 lines (25 loc) · 2.52 KB
Raw

vagrant-jekyll

This VM provides a fresh Jekyll instalation.

We use a standard Ubuntu/Bionic as the base image, and install Ruby + Jekyll.

The website (Jekyll project) source code is copied from the host machine to the guest VM (through shared folders) where Jekyll can be executed transforming the templates, text files and assets into a static website.
The generated website will be localted within the standard _site folder of the Jekyll project sources. Given that the shared folder synchronization is bidirectional (host->guest and guest->host), the _site folder will be available in the host machine too.

Requirements

  • Git
  • VirtualBox
  • Vagrant
  • [Optional] Moonshine-IDE

VirtualBox Vagrant setup

  1. Download and install VirtualBox.
  2. Download and install Vagrant.
  3. Download and install Git.
  4. [Optional] Download and install Moonshine-IDE.
  5. [Optional] If you want to use the Moonshine IDE Website (which is a Jekyll project) to test this, then using Git clone the MoonshineIDE website repository.
    1. IMPORTANT: Comment or remove the gem sass from the Gemfile of the Moonshine IDE website.
  6. Using Git, clone the vagrant-jekyll repository (this project).
  7. Open the project in Moonshine IDE by double-clicking JekyllWebsite.javaproj (or Project > Open/Import Project)
  8. Locate the Vagrantfile in the base path of this project and set the followin variables:
    1. PROJECT_SOURCE_IN_HOST: the path where the Jekyll project (MoonshineWebsite or other) resides.
    2. IS_SASS_USED: if your Jekyll project doesn't use Sass, set this to "false".
    3. RUBY_VERSION: set the Ruby version that will be installed in the VM.
  9. Use the Vagrant support in Moonshine IDE to launch the virtual machine: find the Vagrantfile and use the right click to open the Context menu, select Vagrant > Up. The static website will be available at 127.0.0.1:4000 (by default). You can make changes to your local Jekyll project files and the static website will be automatically updated and reloaded.
  10. Use the Vagrant support in Moonshine IDE to stop the virtual machine: find the Vagrantfile and use the right click to open the Context menu, select Vagrant > Halt.