moviendome/rubyconfth

Website for RubyConf TH { 💎 }

Website for the Ruby Conference Thailand

---

Get Started

Prerequisites

• GCC
• Make
• 
• 
• Yarn

Install

bundle install && yarn install

Development

Without Docker

To start the site in development mode, run bin/bridgetown start and navigate to localhost:4000.

Other commands:

# build & deploy to production
bin/bridgetown deploy

# load the site up within a Ruby console (IRB)
bin/bridgetown console

Learn more: Bridgetown CLI Documentation

With Docker 🐳

To start then site in development mode, run bin/docker-start and navigate to localhost:4000.

Managing Content

All content is written using kramdown which is basically Markdown with the ability to use HTML tags.

Text Content

• Text content is stored in src into sub-directories.
• Each file must contain a front-matter block at the beginning of the file with the config params layout, page_class and title:

layout: default
page_class: home
title: "Home"

Assets

• Media used to enrich text content must be stored in src/images/<media type>/<section-name>.
• In the case of using media other than images, prefer creating a new sub-directory e.g. /videos/<section-name>.
• To embed these media in the content, use the absolute path to each file: /images/<media type>/<section-name>/<filename.extension>.
• SVG icons are combined into a sprite image. Place new icons in /images/shared/icons and regenerate the new sprite image with npm run svg:generate-sprite.

Past Version

Past website versions are kept as Git submodules. So each website lives in its own repository.

In order to add a new past version, commit a compiled version of the site to a public repository and add a new submodule:

git submodule add https://github.com/bangkokrb/rubyconfth-2019.git ./src/past/2019

Store all past version under the directory ./src/past

In order to publish all past version, pull all submodules:

git submodule update --remote --recursive

Use git submodule update --init --recursive when pulling for the first time after cloning this repository

Contributing

Please see CONTRIBUTING.md.

License

This project is 2018 and onwards bangkok.rb. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About

This project is maintained by bangkok.rb