unstruction-jekyll-theme 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +21 -0
- data/README.md +129 -0
- metadata +79 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: f6e12e7fa8e28659a4eac923197ab4dd2db9b9ac3fbe4bc7270cc683dfc390bc
|
|
4
|
+
data.tar.gz: 66911f16e18a7f53bd798dd16355489af450e07adc92565104e3cf03b0a88f49
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: c835037af6246c88bbf3cdcdbbf7d036ee4d7d64ad9edea2417e79f42bf1ff46071e760574b7f06551af11861efc01e5ee6a4fa5575cb13aa67c83e43d6399ea
|
|
7
|
+
data.tar.gz: f7756219f678befc2436c780b5225da6fff95564819b2d0f616a175b20bf579438b120de1e2bdf308d3120688aa4a3558dfeddd7647b1f052c75dd0aa7a30632
|
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Digital Malayali Studio
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# Unstruction
|
|
4
|
+
|
|
5
|
+
[](https://jekyllrb.com)
|
|
6
|
+
[](https://rubygems.org/gems/unstruction-jekyll-theme)
|
|
7
|
+
[](https://rubygems.org/gems/unstruction-jekyll-theme)
|
|
8
|
+
|
|
9
|
+
[](https://github.com/digitalmalayalistudio/unstruction)
|
|
10
|
+
|
|
11
|
+
[](https://liberapay.com/zcraber)
|
|
12
|
+
|
|
13
|
+
A minimal, lightweight, easy and free Jekyll theme to create a 'website under construction' page.
|
|
14
|
+
|
|
15
|
+
[](https://digitalmalayalistudio.github.io/unstruction-jekyll-theme/)
|
|
16
|
+
|
|
17
|
+
[**Live Demo ◉**](https://digitalmalayalistudio.github.io/unstruction-jekyll-theme/)
|
|
18
|
+
|
|
19
|
+
</div>
|
|
20
|
+
|
|
21
|
+
## Contents
|
|
22
|
+
- [Unstruction](#unstruction)
|
|
23
|
+
- [Contents](#contents)
|
|
24
|
+
- [Features](#features)
|
|
25
|
+
- [Installation](#installation)
|
|
26
|
+
- [Use GitHub Template (Easiest Way)](#use-github-template-easiest-way)
|
|
27
|
+
- [Install as GitHub Remote Theme](#install-as-github-remote-theme)
|
|
28
|
+
- [Install as Ruby Gem](#install-as-ruby-gem)
|
|
29
|
+
- [Configuration](#configuration)
|
|
30
|
+
- [`_config.yml`](#_configyml)
|
|
31
|
+
- [Contributing](#contributing)
|
|
32
|
+
- [Development](#development)
|
|
33
|
+
- [License](#license)
|
|
34
|
+
|
|
35
|
+
## Features
|
|
36
|
+
- 😊 Based on the [Unstruction](https://github.com/digitalmalayalistudio/unstruction) template.
|
|
37
|
+
- 👞 Powered by [Shoelace](https://shoelace.style/), an amazing web components library.
|
|
38
|
+
- ⏱️ Displays a countdown timer until the website launch date.
|
|
39
|
+
- 🌙 Automatically chooses dark/light mode based on user's system preference.
|
|
40
|
+
- ☎️ Option to show the necessary contact info.
|
|
41
|
+
|
|
42
|
+
## Installation
|
|
43
|
+
There are multiple ways to install and set up Unstruction. Let's explore each of them.
|
|
44
|
+
|
|
45
|
+
### Use GitHub Template (Easiest Way)
|
|
46
|
+
If you need the quickest way to set this up or if you're a complete beginner to Jekyll, using the GitHub template is the easiest option. Setting this up doesn't require any coding skills. You can also fork the repo.
|
|
47
|
+
|
|
48
|
+
1. Visit [Unstruction](https://github.com/digitalmalayalistudio/unstruction-jekyll-theme) theme repository.
|
|
49
|
+
2. Click the **Use this template** button.
|
|
50
|
+
3. Select **Create a new repository**.
|
|
51
|
+
4. Give it a name and click **Create repository**.
|
|
52
|
+
5. Edit the `_config.yml` file for customization. Check the [Configuration](#configuration) guide for details.
|
|
53
|
+
6. Go to **Settings** > **Pages**. Under **Build and deployment**, select **GitHub Actions** as the source.
|
|
54
|
+
7. If you have a [custom domain](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/), you can enter it. Otherwise, you can view the published website at `https://<username>.github.io/unstruction-jekyll-theme` once the building is complete!
|
|
55
|
+
|
|
56
|
+
### Install as GitHub Remote Theme
|
|
57
|
+
Go to your site's `_config.yml` and replace `theme:` with `remote_theme: digitalmalayalistudio/unstruction-jekyll-theme`.
|
|
58
|
+
|
|
59
|
+
### Install as Ruby Gem
|
|
60
|
+
Add this line to your Jekyll site's `Gemfile`:
|
|
61
|
+
|
|
62
|
+
```ruby
|
|
63
|
+
gem "unstruction-jekyll-theme"
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
And add this line to your Jekyll site's `_config.yml`:
|
|
67
|
+
|
|
68
|
+
```yaml
|
|
69
|
+
theme: unstruction-jekyll-theme
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
And then execute:
|
|
73
|
+
|
|
74
|
+
$ bundle
|
|
75
|
+
|
|
76
|
+
Or install it yourself as:
|
|
77
|
+
|
|
78
|
+
$ gem install unstruction-jekyll-theme
|
|
79
|
+
|
|
80
|
+
## Configuration
|
|
81
|
+
Unstruction is super-easy to customize! There is only one `layout` and that is [default.html](_layouts/default.html).
|
|
82
|
+
|
|
83
|
+
Edit the [_config.yml](_config.yml) file to add your website's name, favicon, image, color theme, launch date and contact details.
|
|
84
|
+
|
|
85
|
+
### `_config.yml`
|
|
86
|
+
```yml
|
|
87
|
+
# Jekyll
|
|
88
|
+
theme: unstruction-jekyll-theme
|
|
89
|
+
|
|
90
|
+
# Site Configuration
|
|
91
|
+
name: Unstruction # Name of your website
|
|
92
|
+
favicon: assets/favicon.svg # SVG favicon of your website
|
|
93
|
+
url: https://digitalmalayalistudio.github.io/linkhub-jekyll-theme # URL of your website
|
|
94
|
+
image: assets/preview.webp # Also used for SEO (og:image)
|
|
95
|
+
color: orange # Preferred theme color based on the Shoelace color tokens. Visit https://shoelace.style/tokens/color#theme-tokens.
|
|
96
|
+
date: Jan 1, 3000, 00:00:00 # Set the planned launch date and time in an ISO 8601 format or use the format shown in the example. Time is optional. Remove this variable if you don't need a countdown.
|
|
97
|
+
|
|
98
|
+
# Contacts
|
|
99
|
+
phone: +91123456789 #Remove any that are not needed
|
|
100
|
+
mail: mail@example.com
|
|
101
|
+
whatsapp: 91123456789
|
|
102
|
+
location: https://maps.google.com/location
|
|
103
|
+
|
|
104
|
+
# Defaults
|
|
105
|
+
defaults:
|
|
106
|
+
-
|
|
107
|
+
scope:
|
|
108
|
+
path: ""
|
|
109
|
+
values:
|
|
110
|
+
layout: "default"
|
|
111
|
+
|
|
112
|
+
# Exclude
|
|
113
|
+
exclude: [README.md, Gemfile.lock, .jekyll-cache/, .github/, CHANGELOG.md, Gemfile, LICENSE.txt, funding.yml, unstruction-jekyll-theme.gemspec]
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Contributing
|
|
117
|
+
[Bug reports](https://github.com/digitalmalayalistudio/unstruction-jekyll-theme) and [pull requests](https://github.com/digitalmalayalistudio/unstruction-jekyll-theme/pulls) are welcome. If you like this theme, please give it a star! And if you've used this theme on your website, feel free to add it below.
|
|
118
|
+
|
|
119
|
+
## Development
|
|
120
|
+
To set up your environment to develop this theme, run `bundle install`.
|
|
121
|
+
|
|
122
|
+
Your theme is set up 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.
|
|
123
|
+
|
|
124
|
+
When your theme is released, only the files in [_layouts](_layouts), [_includes](_includes), [_data](_data) and [assets](assets) tracked with Git will be bundled.
|
|
125
|
+
|
|
126
|
+
To add a custom directory to your theme-gem, please edit the regexp in [unstruction-jekyll-theme.gemspec](unstruction-jekyll-theme.gemspec) accordingly.
|
|
127
|
+
|
|
128
|
+
## License
|
|
129
|
+
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
metadata
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: unstruction-jekyll-theme
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Digital Malayali Studio
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2024-11-06 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: jekyll
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '4.3'
|
|
20
|
+
type: :runtime
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '4.3'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: bundler
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - "~>"
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '2.4'
|
|
34
|
+
type: :development
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - "~>"
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '2.4'
|
|
41
|
+
description:
|
|
42
|
+
email:
|
|
43
|
+
- studio@digitalmalayali.in
|
|
44
|
+
executables: []
|
|
45
|
+
extensions: []
|
|
46
|
+
extra_rdoc_files: []
|
|
47
|
+
files:
|
|
48
|
+
- LICENSE
|
|
49
|
+
- README.md
|
|
50
|
+
homepage: https://digitalmalayalistudio.github.io/linkhub-jekyll-theme
|
|
51
|
+
licenses:
|
|
52
|
+
- MIT
|
|
53
|
+
metadata:
|
|
54
|
+
bug_tracker_uri: https://github.com/digitalmalayalistudio/unstruction-jekyll-theme/issues
|
|
55
|
+
changelog_uri: https://github.com/digitalmalayalistudio/unstruction-jekyll-theme/blob/main/CHANGELOG.md
|
|
56
|
+
documentation_uri: https://github.com/digitalmalayalistudio/unstruction-jekyll-theme#readme
|
|
57
|
+
source_code_uri: https://github.com/digitalmalayalistudio/unstruction-jekyll-theme
|
|
58
|
+
funding_uri: https://liberapay.com/zcraber
|
|
59
|
+
post_install_message:
|
|
60
|
+
rdoc_options: []
|
|
61
|
+
require_paths:
|
|
62
|
+
- lib
|
|
63
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
64
|
+
requirements:
|
|
65
|
+
- - ">="
|
|
66
|
+
- !ruby/object:Gem::Version
|
|
67
|
+
version: '0'
|
|
68
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
69
|
+
requirements:
|
|
70
|
+
- - ">="
|
|
71
|
+
- !ruby/object:Gem::Version
|
|
72
|
+
version: '0'
|
|
73
|
+
requirements: []
|
|
74
|
+
rubygems_version: 3.5.22
|
|
75
|
+
signing_key:
|
|
76
|
+
specification_version: 4
|
|
77
|
+
summary: Unstruction is a free Jekyll theme for setting up a simple and easy 'website
|
|
78
|
+
under construction' page.
|
|
79
|
+
test_files: []
|