DOGE Network Ruby Template

A Jekyll template for creating state-specific DOGE Network websites. This template provides a clean, responsive design with built-in DOGE Network branding and easy customization for any US state.

Table of Contents

• Quick Start
• Customization
  • Replace State Flag
  • Update Content
  • Content Format
  • Add New Pages
• Data Sources
• Deployment
• File Structure
• Support
• License

Quick Start

1. Use This Template

Click the "Use this template" button on GitHub to create your own repository from this template.

2. Run the Setup Script

ruby setup.rb

The setup script will configure your state site using template variables:

• {{STATE_NAME}} - Full state name (e.g., "Kansas")
• {{STATE_ABBREV}} - State abbreviation (e.g., "KS")
• {{STATE_SUBDOMAIN}} - URL subdomain (e.g., "kansas")

These variables are automatically replaced throughout your site files.

3. Install Dependencies

bundle install

4. Start Development Server

bundle exec jekyll serve

Visit http://localhost:4000 to see your site!

Customization

Replace State Flag

1. Download your state's flag SVG from Wikipedia
2. Save it as state-flag.svg in the root directory
3. The site will automatically use your state's flag

Update Content

Edit these files to add your state-specific content:

• index.md - Homepage content
• savings.md - Government savings and efficiency data
• regulations.md - State regulatory information
• _config.yml - Site configuration (already templated)

Content Format

This template supports standard Markdown formatting plus custom embeds for rich content.

Standard Markdown

Use standard Markdown syntax for basic formatting:

• Headers: # H1, ## H2, ### H3, etc.
• Text: **bold**, *italic*, ~~strikethrough~~, `code`
• Lists: Use - or * for bullets, 1. for numbered lists
• Links: [text](url) or [email](mailto:contact@example.com)
• Images: ![alt text](image.jpg)
• Tables: Use | for columns, --- for headers
• Blockquotes: Start lines with >
• Code blocks: Wrap in triple backticks with optional language

For complete Markdown syntax, see GitHub Flavored Markdown documentation.

X (Twitter) Embeds

To embed X posts (formerly Twitter), use:

{% include tweet.html tweet_id="1973969815418384514" %}

Example: The tweet ID is the unique numeric identifier at the end of a tweet URL. Here's how to extract it:

https://twitter.com/username/status/1973969815418384514

  Tweet ID: `1973969815418384514`

{% include tweet.html tweet_id="1973969815418384514" %}

Optional parameters:

• theme: "light" or "dark" (default: "light")
• width: Width of the embed (default: "100%")
• align: "left", "center", or "right" (default: "center")

YouTube Embeds

To embed YouTube videos use:

{% include youtube.html video_id="VIDEO_ID" %}

Example: The YouTube video ID is the unique identifier that comes after v= in a YouTube URL. Here are the different ways to extract it:

https://www.youtube.com/watch?v=dQw4w9WgXcQ

Video ID: `dQw4w9WgXcQ`

{% include youtube.html video_id="dQw4w9WgXcQ" %}

Optional parameters:

• width: Width of the embed (default: "100%")
• height: Height of the embed (default: "315")
• align: "left", "center", or "right" (default: "center")
• autoplay: "1" or "0" (default: "0")
• start: Start time in seconds

Add New Pages

Create new .md files in the root directory. Each file with a title will automatically appear in the navigation menu.

Example:

---
title: Workforce
layout: page
---

## {{STATE_NAME}} Workforce Data

- Employment statistics
- Government hiring data
- Workforce development programs

Data Sources

• Start with DOGE Network Tables Repository
• Connect with people on community@dogenetwork.org for ideas

Deployment

Vercel

• Request to be added to the Vercel deployment through community@dogenetwork.org

File Structure

├── _config.yml          # Site configuration (templated)
├── _includes/           # Reusable components
│   ├── header.html      # Site header (templated)
│   └── footer.html      # Site footer
├── assets/              # CSS and styling
├── index.md             # Homepage (templated)
├── savings.md           # Savings page (templated)
├── regulations.md       # Regulations page (templated)
├── state-flag.svg       # Your state's flag (replace this)
├── doge-network.png     # DOGE Network logo
├── setup.rb             # Template setup script
├── CHANGELOG.md         # Changes by release version
└── README.md            # This file

Support

• DOGE Network: community@dogenetwork.org
• Documentation: dogenetwork.org/docs

License

This template is licensed under Apache 2.0 and CC-BY. See LICENSE.md for details.

---

Built with ❤️ by the DOGE Network community