Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 2.58 KB

README.md

File metadata and controls

73 lines (48 loc) · 2.58 KB
Raw

VCW-Tech

Welcome to the repository for VCWTech. This site is built with Jekyll, a static site generator, and styled using Bootstrap (included via CDN). It's automatically built and deployed using GitHub Actions.

Auto Update Changelog Build and deploy Jekyll site pages-build-deployment

Features

  • Responsive design with Bootstrap
  • Automated build and deployment with GitHub Actions
  • Includes custom JavaScript and CSS

Prerequisites

To set up this project locally, you will need the following:

  • Ruby (version as specified in .ruby-version)
  • Bundler (gem install bundler)
  • Jekyll (gem install jekyll)

Local Development

  1. Clone the repository:

    git clone https://github.com/yourusername/my-jekyll-site.git
cd my-jekyll-site

  2. Install dependencies:

    bundle install

  3. Serve the site locally:

    bundle exec jekyll serve

    You can now view the site at localhost:4000.

Structure

  • _layouts: Jekyll HTML layouts.
  • _includes: Reusable HTML snippets.
  • _sass: Sass partials for styling.
  • assets: Contains static files such as images, CSS, and JavaScript.
  • _config.yml: Configuration settings for Jekyll.
  • .github/workflows/jekyll.yml: GitHub Actions workflow for CI/CD.
  • Gemfile: Ruby dependencies for Jekyll.

Contributing

Contributions to this site are welcome. Here's how you can contribute:

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

For more details on contributing, please read CONTRIBUTING.md.

Deployment

This site is automatically built and deployed by GitHub Actions when changes are pushed to the main branch.

License

This project is open source and available under the MIT License.