Skip to content

DEVRhylme-Foundation/devrhylme.blog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

DevRhylme - Open Source Blog

Hugo License: MIT

A modern, feature-rich blog site for the DevRhylme open source community. Built with Hugo for blazing-fast performance and easy content management.

πŸš€ Features

  • πŸ“ Blog System - Categorized posts with tags, authors, and reading time
  • 🎨 Modern Design - Responsive, clean interface with dark/light mode
  • πŸ’» Syntax Highlighting - Beautiful code blocks for technical content
  • πŸ” Search Functionality - Fast client-side search
  • πŸ“± Mobile Responsive - Works seamlessly on all devices
  • 🌐 Multilingual Ready - Support for multiple languages
  • πŸ“Š GitHub Integration - Display repository stats and contributors
  • πŸ’¬ Comments System - Community engagement via Giscus/Utterances
  • πŸ“– Documentation - Comprehensive docs section
  • πŸ‘₯ Team Pages - Showcase your contributors
  • 🎯 Project Showcase - Highlight your open source projects
  • πŸŽ‰ Events Calendar - Community meetups and events
  • ⚑ Performance - Lightning-fast static site generation
  • πŸ”’ Privacy-Focused - Respects user privacy

πŸ“‹ Prerequisites

Before you begin, ensure you have the following installed:

πŸ› οΈ Installation

  1. Clone the repository

    git clone https://github.com/yourusername/devrhylme.blog.git
    cd devrhylme.blog
  2. Install dependencies (if using npm for assets)

    npm install
  3. Run the development server

    hugo server -D
  4. Open your browser Navigate to http://localhost:1313

πŸ“ Project Structure

devrhylme.blog/
β”œβ”€β”€ archetypes/          # Content templates
β”œβ”€β”€ content/             # All site content (markdown)
β”‚   β”œβ”€β”€ blog/           # Blog posts
β”‚   β”œβ”€β”€ projects/       # Project pages
β”‚   β”œβ”€β”€ docs/           # Documentation
β”‚   β”œβ”€β”€ team/           # Team member profiles
β”‚   β”œβ”€β”€ community/      # Community guidelines
β”‚   └── events/         # Events and meetups
β”œβ”€β”€ data/               # Data files (JSON/YAML)
β”œβ”€β”€ static/             # Static assets
β”œβ”€β”€ themes/             # Custom theme
β”‚   └── opensourceorg/
β”‚       β”œβ”€β”€ layouts/    # HTML templates
β”‚       β”œβ”€β”€ static/     # Theme assets
β”‚       └── assets/     # Processed assets
└── hugo.toml           # Site configuration

✍️ Creating Content

Create a new blog post

hugo new blog/my-first-post.md

Create a new project

hugo new projects/awesome-project.md

Create a team member profile

hugo new team/john-doe.md

βš™οΈ Configuration

Edit hugo.toml to customize:

  • Site title and description
  • Social media links
  • GitHub organization/repository
  • Enable/disable features
  • Menu items
  • Theme colors

🎨 Customization

Modify theme colors

Edit themes/opensourceorg/assets/scss/_variables.scss

Add custom CSS

Place files in themes/opensourceorg/static/css/

Add custom JavaScript

Place files in themes/opensourceorg/static/js/

πŸš€ Deployment

Build for production

hugo --minify

The site will be generated in the public/ directory.

Deploy to GitHub Pages

hugo --minify
# Push the public/ directory to gh-pages branch

Deploy to Netlify

  1. Connect your repository to Netlify
  2. Build command: hugo --minify
  3. Publish directory: public

Deploy to Vercel

  1. Import your repository
  2. Framework: Hugo
  3. Build command: hugo --minify
  4. Output directory: public

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

πŸ“ Content Guidelines

  • Write in Markdown format
  • Use proper frontmatter metadata
  • Include relevant tags and categories
  • Add featured images when possible
  • Follow the style guide

πŸ› Bug Reports

Found a bug? Please open an issue with:

  • Clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots if applicable

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ‘₯ Community

πŸ™ Acknowledgments

  • Hugo community for the amazing static site generator
  • All our contributors and supporters
  • Open source projects that inspired this design

πŸ“ž Support

Need help?


Made with ❀️ by the DevRhylme community

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •