Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AzielLans/jekyll-theme-unity

Based on Material 3 design principles
https://github.com/AzielLans/jekyll-theme-unity

jekyll jekyll-theme material-design theme

Last synced: about 2 months ago
JSON representation

Based on Material 3 design principles

Awesome Lists containing this project

README

        

![mobile](https://user-images.githubusercontent.com/100028421/221540408-2ec923ef-9f24-4b7a-9ce8-a45ac45d64bd.png)

Unity

# Unity Theme [![Gem Version](https://badge.fury.io/rb/jekyll-theme-unity.svg)](https://badge.fury.io/rb/jekyll-theme-unity)
See [Unity Theme](https://involts.github.io//jekyll-theme-unity/) in action or [download it today!](https://github.com/Involts/jekyll-theme-unity/zipball/master)

United design language, simple design and multipurpose theme

# Features
- Light/dark Theme toggle
- Flat UI
- Built-in Commands
- Google Analytics
- Anchor Headings
- Table of Contents
- Video embed support
- Syntax Highlighting
- Pinned Post

# Quick Start
## Prerequisites

Follow the instructions in [jekyll Docs](https://jekyllrb.com/docs/installation/) to install `Ruby`, `RubyGems`, and `Bundler`. You may also install [Git](https://git-scm.com/)

## Step 1: Creating a site

Create a new repository from the [Unity Starter](https://github.com/Involts/Unity-Theme-Starter/generate) and name it .github.io, where GH_USERNAME represents your GitHub username.

## Step 2: Installing Dependencies

Before running for the first time, go to the root directory of your site, and install dependencies as follows:

```Console
$ bundle
```

## Step 3. Running Local Server
Run the following command in the root directory of the site:

```Console
$ bundle exec jekyll s
```

After a while, navigate to the site at http://localhost:4000.

## Documentation
For more details on usage, please refer to the tutorial on the demo [website](https://involts.github.io/jekyll-theme-unity/home) / [wiki](https://github.com/Involts/jekyll-theme-unity/wiki). Note that the tutorial is based on the latest release, and the features of the default branch are usually ahead of the documentation.

## Contributing

Interested in contributing to Unity Theme? We'd love your help. Unity Theme is an open source project, built one contribution at a time by users like you. See [the contributing file](.github/CONTRIBUTING.md) for instructions on how to contribute.

## Licence
This work is published under [MIT](https://github.com/Involts/jekyll-theme-unity/blob/master/LICENSE.txt) License.