Code Monkey home page Code Monkey logo

stc-jekyll-docker's Introduction

STC-Jekyll-Docker

A docker wrapper for Jekyll, configured to be run with STC website (compatibility with other Jekyll-related projects are not tested).

If you're using Linux or MacOS, use RVM directly.

Prerequisite

  1. Virtualization is enabled (Instructions to check here)
    • If virtualization is not enabled, ask a friend
  2. Docker Toolbox is installed download link

How to install

  1. Run Docker Quickstart Terminal
  2. In the terminal, navigate to user profile with cd ~
  3. Run git clone https://github.com/tom-ng/STC-Jekyll-Docker.git
  4. Enter STC-Jekyll-Docker folder with cd STC-Jekyll-Docker
  5. Fork and set up the repo of sunwaytechclub website, tutorial to do so here
  6. Go into the repo with cd sunwaytechclub-site
  7. Checkout the source-dev branch by running git checkout source-dev
  8. To run, simply type docker-compose up -d in STC-Jekyll-Docker folder

How to develop STC website

  1. Run Docker Quickstart Terminal
  2. Navigate to STC-Jekyll-Docker
  3. docker-compose up -d
  4. Edit contents in sunwaytechclub-website
  5. You can see changes you made after a reload on browser
  6. Push and request PR after committing the changes, ask a friend if you aren't sure how.
  7. Website is available to view from 192.168.99.100

How to exit from Docker or the container gracefully (properly)

  1. Run docker-compose down in STC-Jekyll-Docker directory
  2. Exit the terminal

Further documentations on how to operate Git and developing STC website will be listed in that repo/trello.

stc-jekyll-docker's People

Contributors

tom-ng avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.