|
| 1 | +# Ruby Taiwan |
| 2 | + |
| 3 | +The official website of the [Ruby Taiwan](https://ruby.tw) community, built with [Jekyll](https://jekyllrb.com/) static site generator. The site serves as a central hub for Taiwan's Ruby community, featuring events, blog posts, community campaigns, and related resources. |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +### Prerequisites |
| 8 | + |
| 9 | +- Ruby (see `.ruby-version`) |
| 10 | +- Bundler |
| 11 | + |
| 12 | +### Installation |
| 13 | + |
| 14 | +```bash |
| 15 | +bundle install |
| 16 | +``` |
| 17 | + |
| 18 | +### Development |
| 19 | + |
| 20 | +```bash |
| 21 | +bundle exec jekyll serve # Start dev server at http://localhost:4000 |
| 22 | +bundle exec jekyll build # Build static site to _site/ |
| 23 | +``` |
| 24 | + |
| 25 | +### Linting |
| 26 | + |
| 27 | +```bash |
| 28 | +bundle exec rubocop # Ruby code style check |
| 29 | +``` |
| 30 | + |
| 31 | +## Project Structure |
| 32 | + |
| 33 | +``` |
| 34 | +├── _data/ # YAML data files (campaigns, communities, i18n, social media) |
| 35 | +├── _events/ # Event collection (Markdown with front matter) |
| 36 | +├── _includes/ # Reusable Liquid template partials |
| 37 | +├── _layouts/ # Page templates (default, landing, post) |
| 38 | +├── _posts/ # Blog posts (date-based naming convention) |
| 39 | +├── _sass/ # SASS stylesheets (indented .sass syntax) |
| 40 | +│ ├── base/ # Mixins and style guide |
| 41 | +│ └── style/ # Per-section styles |
| 42 | +└── assets/ # Static assets (CSS, JS, images) |
| 43 | +``` |
| 44 | + |
| 45 | +## Tech Stack |
| 46 | + |
| 47 | +- **Static Site Generator**: Jekyll |
| 48 | +- **CSS Framework**: Bootstrap 3.4.1 |
| 49 | +- **JavaScript**: jQuery 3.7.1 (with Easing and TouchSwipe plugins) |
| 50 | +- **Icons**: Font Awesome 4.7.0 |
| 51 | +- **Fonts**: Google Fonts (Montserrat, Lobster) |
| 52 | +- **Stylesheets**: SASS (indented syntax) |
| 53 | +- **Deployment**: GitHub Pages via GitHub Actions |
| 54 | + |
| 55 | +## Contributing |
| 56 | + |
| 57 | +### Adding Events |
| 58 | + |
| 59 | +Create a new file `YYYY-MM-DD-slug.md` in `_events/` with the following front matter: |
| 60 | + |
| 61 | +```yaml |
| 62 | +--- |
| 63 | +title: "Event Title" |
| 64 | +date: YYYY-MM-DD |
| 65 | +location: "Venue Name" |
| 66 | +time: "HH:MM" |
| 67 | +event_url: "https://..." |
| 68 | +--- |
| 69 | +``` |
| 70 | + |
| 71 | +Mark ended events by adding `ended: true` to the front matter. |
| 72 | + |
| 73 | +### Adding Blog Posts |
| 74 | + |
| 75 | +Create a new file `YYYY-MM-DD-slug.md` in `_posts/` with the following front matter: |
| 76 | + |
| 77 | +```yaml |
| 78 | +--- |
| 79 | +title: "Post Title" |
| 80 | +cover: "optional-cover-image-url" |
| 81 | +--- |
| 82 | +``` |
| 83 | + |
| 84 | +### Adding Community Campaigns |
| 85 | + |
| 86 | +Edit `_data/campaigns.yml` to add new campaign entries. |
| 87 | + |
| 88 | +### Translations |
| 89 | + |
| 90 | +UI strings are managed in `_data/i18n.yml`. |
| 91 | + |
| 92 | +## License |
| 93 | + |
| 94 | +This project is maintained by the Ruby Taiwan community. |
0 commit comments