Monophase

Monophase is a one-column minimal responsive Jekyll blog theme.

One of the purposes of Monophase is to be an alternative option to the default theme of Jekyll—Minima. Monophase is still keeping minimal, but meanwhile, more beautiful and mellow, and doesn't lose some useful basic features, such as archive.

Check the live demo.

Highlight Features

Normalize.css
Open Color
Font Awesome
Disqus
MathJax
Google Analytics 4
Jekyll Feed
Jekyll Paginate
Jekyll SEO Tag
Related posts (time-based, because Jekyll) below each post
Dark mode, via prefers-color-scheme
Archive implemented by pure Liquid

Installation
Usage
Contributing
Development
License

Installation

Add this line to your Jekyll site's Gemfile:

gem "monophase"

And add this line to your Jekyll site's _config.yml:

theme: monophase

And then execute:

bundle

Or install it yourself as:

gem install monophase

You can also install the latest code via jekyll-remote-theme:

Add this line to your Jekyll site's Gemfile:
```
gem "jekyll-remote-theme"
```

Add these lines to your Jekyll site's _config.yml:

plugins:
  - jekyll-remote-theme

remote_theme: zivhub/monophase@main

Usage

Global Configuration

Variable	Type	Default	Specification
`title`	String	---	The title of the website
`tagline`	String	---	The tagline of the website
`lang`	String	`en`	The language of pages; The value can be overwritten by the `lang` variable on each page
`author.name`	String	---	The name of the website author
`author.url`	String	---	A URL of the website author
`tags_path`	String	---	A path to the archive-by-tags page; It is used by tags on each post
`categories_path`	String	---	A path to the archive-by-categories page; It is used by categories on each post
`disqus`	String	---	Disqus short name
`google_analytics`	String	---	Google Analytics 4 Measurement ID

Post Configuration

Variable	Type	Default	Specification
`description`	String	---	A description of the current post
`last_modified_at`	String	---	The date of the last modification you made on a post after its publishing
`author`	String or Array	---	The author name(s) of the post
`comments`	Boolean	`true`	Does enable the Disqus comment system
`math`	Boolean	`false`	Does enable MathJax on this page

Homepage

You can create a homepage for your blog by setting layout: home in your index.html.

Custom Head

Monophase leaves a placeholder to allow defining custom head. All you need to do is putting data into _includes/custom-head.html, and they would be automatically included in <head>.

Navigation

The navigation bar of Monophase is configurable. You just need to specify titles and URLs in the file _data/navigation.yml, for example,

- title: About
  url: /about/
- title: Archive
  url: /archive/
- title: Categories
  url: /categories/

Social Links

Monophase allows you to show social links on the website. All you need to do is creating a file _data/social.yml, for example,

- title: Email
  url: mailto:[email protected]
  icon: fas fa-envelope
- title: Twitter
  url: https://twitter.com/zivtwt
  icon: fab fa-twitter
- title: GitHub
  url: https://github.com/zivhub
  icon: fab fa-github

Alert Messages

Monophase provides some predefined classes to specify different levels of alert messages. In order of tone from light to heavy, they are: message-info, message-warning, and message-danger. You may add it to single elements like a <p>, or to a parent if there are multiple elements to show.

Google Analytics 4

To enable Google Analytics 4, you just need to set the Measurement ID in your _config.yml, for example,

google_analytics: G-XXXXXXX

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/zivhub/monophase. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in monophase.gemspec accordingly.

License

The theme is available as open source under the terms of the MIT License.

Jekyll_theme

Build Repository for Campus Activities

Description:
This repository is designed for campuses to submit proof of work for their conducted activities, referred to as "Campus Karma." The submission will include event photos, participant MU IDs, faculty MU IDs, enabler MU IDs, and their names. Additionally, campuses can submit details of their learning circle-based activities. The repository will be built using Jekyll, and campus leads will need to edit markdown files as per the provided template. Karma points will be automatically updated with GitHub Actions using the provided MU IDs.

Goals:

Create a Jekyll-based repository for campuses to submit activity proof.
Enable automatic updates of karma points using GitHub Actions.
Ensure easy editing of markdown files by campus leads.
Facilitate the inclusion of event photos and MU IDs for participants, faculty, and enablers.

Expected Outcomes:

A functional Jekyll site that campuses can use to submit activities.
Templates for markdown files that campuses can easily edit.
Automated karma point updates via GitHub Actions.
A user-friendly interface for submitting event photos and MU IDs.

Acceptance Criteria:

Jekyll Setup:
- The repository is correctly set up with Jekyll.
- The site structure supports easy navigation and submission of activities.
Markdown Templates:
- Templates are provided for campuses to submit their activities.
- Templates include fields for event photos, participant MU IDs, faculty MU IDs, enabler MU IDs, and names.
GitHub Actions:
- GitHub Actions are configured to automatically update karma points based on submitted MU IDs.
- The process is tested and verified to work correctly.
User Interface:
- Clear instructions are provided for campus leads on how to edit and submit markdown files.
- The submission process is tested to ensure it is user-friendly and error-free.

Implementation Details:

Repository Setup:
- Initialize a new Jekyll site.
- Set up the directory structure for markdown submissions.
Template Creation:
- Design and create markdown templates for activity submissions.
- Ensure templates are easy to understand and fill out.
GitHub Actions:
- Write scripts for GitHub Actions to process submitted markdown files.
- Implement logic to update karma points based on MU IDs.
Documentation:
- Provide detailed documentation on how to use the repository.
- Include examples and FAQs to assist campus leads.

Necessary Tech Skills: Jekyll, Markdown, GitHub Actions, HTML/CSS

Mentor Tags: @rejahrehim

Complexity: Medium

Relevant Categories: Community, Automation, Web Development

Links to Mockups/Wireframes: (Include links if available)

If there are any additional details or modifications needed, please let me know!

gtech-mulearn / mucampus-events Goto Github PK

mucampus-events's Introduction

Monophase

Highlight Features

Table of Contents

Installation

Usage

Global Configuration

Post Configuration

Homepage

Custom Head

Navigation

Social Links

Alert Messages

Google Analytics 4

Archive

Contributing

Development

License

Jekyll_theme

mucampus-events's People

Contributors

Forkers

mucampus-events's Issues

Recommend Projects

Recommend Topics

Recommend Org