styless 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +24 -0
  3. data/README.md +319 -0
  4. data/_layouts/default.html +8 -0
  5. metadata +109 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 0663ea64377c63e3725dabee4e1c3b366a18e5c6a6adb28260080d640aa9c022
4
+ data.tar.gz: cf52f1eac9d0292b18fdddb8be476eb6c692fe8c63029336048a8fe17dacd232
5
+ SHA512:
6
+ metadata.gz: ee18512d3279b2324eec078855895cbfaa17d7a6459fff609abe4645334203b724917730a978530aca7bbc2322ff5a580d03fdc7ffe287e9e812b0634fa47b53
7
+ data.tar.gz: 271481df649a8bf89157a7d00058da4996d58295650ebee4901095999dfb7937d2f745ec0cc11ebd371b38cdf2d3600ed0d31759e097185fa8cf70b966301d80
data/LICENSE ADDED
@@ -0,0 +1,24 @@
1
+ This is free and unencumbered software released into the public domain.
2
+
3
+ Anyone is free to copy, modify, publish, use, compile, sell, or
4
+ distribute this software, either in source code form or as a compiled
5
+ binary, for any purpose, commercial or non-commercial, and by any
6
+ means.
7
+
8
+ In jurisdictions that recognize copyright laws, the author or authors
9
+ of this software dedicate any and all copyright interest in the
10
+ software to the public domain. We make this dedication for the benefit
11
+ of the public at large and to the detriment of our heirs and
12
+ successors. We intend this dedication to be an overt act of
13
+ relinquishment in perpetuity of all present and future rights to this
14
+ software under copyright law.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19
+ IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20
+ OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21
+ ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22
+ OTHER DEALINGS IN THE SOFTWARE.
23
+
24
+ For more information, please refer to <https://unlicense.org>
data/README.md ADDED
@@ -0,0 +1,319 @@
1
+ # Styless
2
+
3
+ *Styless is an unstyled Jekyll theme for writers*.
4
+
5
+ *Running `bundle show styless` will provide you with the local path to your current theme version.*
6
+
7
+
8
+ [Theme preview](https://moonharelabs.github.io/styless/)
9
+
10
+ ![styless theme preview](/screenshot.png)
11
+
12
+ ## Installation
13
+
14
+ Add this line to your Jekyll site's Gemfile:
15
+
16
+ ```ruby
17
+ gem "styless"
18
+ ```
19
+
20
+ And then execute:
21
+
22
+ $ bundle
23
+
24
+
25
+ ## Contents At-A-Glance
26
+
27
+ Minima has been scaffolded by the `jekyll new-theme` command and therefore has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration.
28
+
29
+ ### Layouts
30
+
31
+ Refers to files within the `_layouts` directory, that define the markup for your theme.
32
+
33
+ - `default.html` &mdash; The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says ` {{ content }} ` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`.
34
+ - `home.html` &mdash; The layout for your landing-page / home-page / index-page. [[More Info.](#home-layout)]
35
+ - `page.html` &mdash; The layout for your documents that contain FrontMatter, but are not posts.
36
+ - `post.html` &mdash; The layout for your posts.
37
+
38
+ #### Home Layout
39
+
40
+ `home.html` is a flexible HTML layout for the site's landing-page / home-page / index-page. <br/>
41
+
42
+ ##### *Main Heading and Content-injection*
43
+
44
+ From Minima v2.2 onwards, the *home* layout will inject all content from your `index.md` / `index.html` **before** the **`Posts`** heading. This will allow you to include non-posts related content to be published on the landing page under a dedicated heading. *We recommended that you title this section with a Heading2 (`##`)*.
45
+
46
+ Usually the `site.title` itself would suffice as the implicit 'main-title' for a landing-page. But, if your landing-page would like a heading to be explicitly displayed, then simply define a `title` variable in the document's front matter and it will be rendered with an `<h1>` tag.
47
+
48
+ ##### *Post Listing*
49
+
50
+ This section is optional from Minima v2.2 onwards.<br/>
51
+ It will be automatically included only when your site contains one or more valid posts or drafts (if the site is configured to `show_drafts`).
52
+
53
+ The title for this section is `Posts` by default and rendered with an `<h2>` tag. You can customize this heading by defining a `list_title` variable in the document's front matter.
54
+
55
+
56
+ ### Includes
57
+
58
+ Refers to snippets of code within the `_includes` directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.
59
+
60
+ - `disqus_comments.html` &mdash; Code to markup disqus comment box.
61
+ - `footer.html` &mdash; Defines the site's footer section.
62
+ - `google-analytics.html` &mdash; Inserts Google Analytics module (active only in production environment).
63
+ - `head.html` &mdash; Code-block that defines the `<head></head>` in *default* layout.
64
+ - `custom-head.html` &mdash; Placeholder to allow users to add more metadata to `<head />`.
65
+ - `header.html` &mdash; Defines the site's main header section. By default, pages with a defined `title` attribute will have links displayed here.
66
+ - `social.html` &mdash; Renders social-media icons based on the `minima:social_links` data in the config file.
67
+
68
+
69
+ ### Sass
70
+
71
+ Refers to `.scss` files within the `_sass` directory that define the theme's styles.
72
+
73
+ - `minima/skins/classic.scss` &mdash; The "classic" skin of the theme. *Used by default.*
74
+ - `minima/initialize.scss` &mdash; A component that defines the theme's *skin-agnostic* variable defaults and sass partials.
75
+ It imports the following components (in the following order):
76
+ - `minima/custom-variables.scss` &mdash; A hook that allows overriding variable defaults and mixins. (*Note: Cannot override styles*)
77
+ - `minima/_base.scss` &mdash; Sass partial for resets and defines base styles for various HTML elements.
78
+ - `minima/_layout.scss` &mdash; Sass partial that defines the visual style for various layouts.
79
+ - `minima/custom-styles.scss` &mdash; A hook that allows overriding styles defined above. (*Note: Cannot override variables*)
80
+
81
+ Refer the [skins](#skins) section for more details.
82
+
83
+
84
+ ### Assets
85
+
86
+ Refers to various asset files within the `assets` directory.
87
+
88
+ - `assets/css/style.scss` &mdash; Imports sass files from within the `_sass` directory and gets processed into the theme's
89
+ stylesheet: `assets/css/styles.css`.
90
+ - `assets/minima-social-icons.svg` &mdash; A composite SVG file comprised of *symbols* related to various social-media icons.
91
+ This file is used as-is without any processing. Refer [section on social networks](#social-networks) for its usage.
92
+
93
+
94
+ ### Plugins
95
+
96
+ Minima comes with [`jekyll-seo-tag`](https://github.com/jekyll/jekyll-seo-tag) plugin preinstalled to make sure your website gets the most useful meta tags. See [usage](https://github.com/jekyll/jekyll-seo-tag#usage) to know how to set it up.
97
+
98
+
99
+ ## Usage
100
+
101
+ Have the following line in your config file:
102
+
103
+ ```yaml
104
+ theme: minima
105
+ ```
106
+
107
+
108
+ ### Customizing templates
109
+
110
+ To override the default structure and style of minima, simply create the concerned directory at the root of your site, copy the file you wish to customize to that directory, and then edit the file.
111
+ e.g., to override the [`_includes/head.html `](_includes/head.html) file to specify a custom style path, create an `_includes` directory, copy `_includes/head.html` from minima gem folder to `<yoursite>/_includes` and start editing that file.
112
+
113
+ The site's default CSS has now moved to a new place within the gem itself, [`assets/css/style.scss`](assets/css/style.scss).
114
+
115
+ In Minima 3.0, if you only need to customize the colors of the theme, refer to the subsequent section on skins. To have your
116
+ *CSS overrides* in sync with upstream changes released in future versions, you can collect all your overrides for the Sass
117
+ variables and mixins inside a sass file placed at `_sass/minima/custom-variables.scss` and all other overrides inside a sass file
118
+ placed at path `_sass/minima/custom.scss`.
119
+
120
+ You need not maintain entire partial(s) at the site's source just to override a few styles. However, your stylesheet's primary
121
+ source (`assets/css/style.scss`) should contain the following:
122
+
123
+ - Front matter dashes at the very beginning (can be empty).
124
+ - Directive to import a skin.
125
+ - Directive to import the base styles (automatically loads overrides when available).
126
+
127
+ Therefore, your `assets/css/style.scss` should contain the following at minimum:
128
+
129
+ ```sass
130
+ ---
131
+ ---
132
+
133
+ @import "minima/skins/{{ site.minima.skin | default: 'classic' }}";
134
+ @import "minima/initialize";
135
+ ```
136
+
137
+ #### Skins
138
+
139
+ Minima 3.0 supports defining and switching between multiple color-palettes (or *skins*).
140
+
141
+ ```
142
+ .
143
+ ├── minima.scss
144
+ └── minima
145
+ └── _syntax-highlighting.scss
146
+ ```
147
+
148
+
149
+ A skin is a Sass file placed in the directory `_sass/minima/skins` and it defines the variable defaults related to the "color"
150
+ aspect of the theme. It also embeds the Sass rules related to syntax-highlighting since that is primarily related to color and
151
+ has to be adjusted in harmony with the current skin.
152
+
153
+ The default color palette for Minima is defined within `_sass/minima/skins/classic.scss`. To switch to another available skin,
154
+ simply declare it in the site's config file. For example, to activate `_sass/minima/skins/dark.scss` as the skin, the setting
155
+ would be:
156
+
157
+ ```yaml
158
+ minima:
159
+ skin: dark
160
+ ```
161
+
162
+ As part of the migration to support skins, some existing Sass variables have been retired and some **have been redefined** as
163
+ summarized in the following table:
164
+
165
+ Minima 2.0 | Minima 3.0
166
+ --------------- | ----------
167
+ `$brand-color` | `$link-base-color`
168
+ `$grey-*` | `$brand-*`
169
+ `$orange-color` | *has been removed*
170
+
171
+ ##### Available skins
172
+
173
+ - classic
174
+ - dark
175
+ - solarized
176
+ - solarized-dark
177
+
178
+ ### Customize navigation links
179
+
180
+ This allows you to set which pages you want to appear in the navigation area and configure order of the links.
181
+
182
+ For instance, to only link to the `about` and the `portfolio` page, add the following to your `_config.yml`:
183
+
184
+ ```yaml
185
+ header_pages:
186
+ - about.md
187
+ - portfolio.md
188
+ ```
189
+
190
+
191
+ ### Change default date format
192
+
193
+ You can change the default date format by specifying `site.minima.date_format`
194
+ in `_config.yml`.
195
+
196
+ ```
197
+ # Minima date format
198
+ # refer to http://shopify.github.io/liquid/filters/date/ if you want to customize this
199
+ minima:
200
+ date_format: "%b %-d, %Y"
201
+ ```
202
+
203
+
204
+ ### Extending the `<head />`
205
+
206
+ You can *add* custom metadata to the `<head />` of your layouts by creating a file `_includes/custom-head.html` in your source directory. For example, to add favicons:
207
+
208
+ 1. Head over to [https://realfavicongenerator.net/](https://realfavicongenerator.net/) to add your own favicons.
209
+ 2. [Customize](#customization) default `_includes/custom-head.html` in your source directory and insert the given code snippet.
210
+
211
+
212
+ ### Enabling comments (via Disqus)
213
+
214
+ Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.
215
+
216
+ To enable it, add the following lines to your Jekyll site:
217
+
218
+ ```yaml
219
+ disqus:
220
+ shortname: my_disqus_shortname
221
+ ```
222
+
223
+ You can find out more about Disqus' shortnames [here](https://help.disqus.com/installation/whats-a-shortname).
224
+
225
+ Comments are enabled by default and will only appear in production, i.e., `JEKYLL_ENV=production`
226
+
227
+ If you don't want to display comments for a particular post you can disable them by adding `comments: false` to that post's YAML Front Matter.
228
+
229
+ :warning: `url`, e.g. `https://example.com`, must be set in you config file for Disqus to work.
230
+
231
+ ### Author Metadata
232
+
233
+ From `Minima-3.0` onwards, `site.author` is expected to be a mapping of attributes instead of a simple scalar value:
234
+
235
+ ```yaml
236
+ author:
237
+ name: John Smith
238
+ email: "john.smith@foobar.com"
239
+ ```
240
+
241
+ To migrate existing metadata, update your config file and any reference to the object in your layouts and includes as summarized below:
242
+
243
+ Minima 2.x | Minima 3.0
244
+ ------------- | -------------------
245
+ `site.author` | `site.author.name`
246
+ `site.email` | `site.author.email`
247
+
248
+
249
+ ### Social networks
250
+
251
+ You can add links to the accounts you have on other sites, with respective icon, by adding one or more of the following options in your config.
252
+ From `Minima-3.0` onwards, the usernames are to be nested under `minima.social_links`, with the keys being simply the social-network's name:
253
+
254
+ ```yaml
255
+ minima:
256
+ social_links:
257
+ twitter: jekyllrb
258
+ github: jekyll
259
+ stackoverflow: "11111"
260
+ dribbble: jekyll
261
+ facebook: jekyll
262
+ flickr: jekyll
263
+ instagram: jekyll
264
+ linkedin: jekyll
265
+ pinterest: jekyll
266
+ telegram: jekyll
267
+ microdotblog: jekyll
268
+ keybase: jekyll
269
+
270
+ mastodon:
271
+ - username: jekyll
272
+ instance: example.com
273
+ - username: jekyll2
274
+ instance: example.com
275
+
276
+ gitlab:
277
+ - username: jekyll
278
+ instance: example.com
279
+ - username: jekyll2
280
+ instance: example.com
281
+
282
+ youtube: jekyll
283
+ youtube_channel: UC8CXR0-3I70i1tfPg1PAE1g
284
+ youtube_channel_name: CloudCannon
285
+ ```
286
+
287
+
288
+ ### Enabling Google Analytics
289
+
290
+ To enable Google Analytics, add the following lines to your Jekyll site:
291
+
292
+ ```yaml
293
+ google_analytics: UA-NNNNNNNN-N
294
+ ```
295
+
296
+ Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`
297
+
298
+ ### Enabling Excerpts on the Home Page
299
+
300
+ To display post-excerpts on the Home Page, simply add the following to your `_config.yml`:
301
+
302
+ ```yaml
303
+ show_excerpts: true
304
+ ```
305
+
306
+
307
+ ## Contributing
308
+
309
+ Bug reports and pull requests are welcome on GitHub at https://github.com/jekyll/minima. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
310
+
311
+ ## Development
312
+
313
+ To set up your environment to develop this theme, run `script/bootstrap`.
314
+
315
+ To test your theme, run `script/server` (or `bundle exec jekyll serve`) and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme and the contents. As you make modifications, your site will regenerate and you should see the changes in the browser after a refresh.
316
+
317
+ ## License
318
+
319
+ The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
@@ -0,0 +1,8 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <body>
4
+
5
+ {{ content }}
6
+
7
+ </body>
8
+ </html>
metadata ADDED
@@ -0,0 +1,109 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: styless
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Kavindu Santhusa
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-02-13 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: '3.5'
20
+ - - "<"
21
+ - !ruby/object:Gem::Version
22
+ version: '5.0'
23
+ type: :runtime
24
+ prerelease: false
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ version: '3.5'
30
+ - - "<"
31
+ - !ruby/object:Gem::Version
32
+ version: '5.0'
33
+ - !ruby/object:Gem::Dependency
34
+ name: jekyll-feed
35
+ requirement: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '0.9'
40
+ type: :runtime
41
+ prerelease: false
42
+ version_requirements: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: '0.9'
47
+ - !ruby/object:Gem::Dependency
48
+ name: jekyll-seo-tag
49
+ requirement: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - "~>"
52
+ - !ruby/object:Gem::Version
53
+ version: '2.1'
54
+ type: :runtime
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - "~>"
59
+ - !ruby/object:Gem::Version
60
+ version: '2.1'
61
+ - !ruby/object:Gem::Dependency
62
+ name: bundler
63
+ requirement: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - ">="
66
+ - !ruby/object:Gem::Version
67
+ version: '0'
68
+ type: :development
69
+ prerelease: false
70
+ version_requirements: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - ">="
73
+ - !ruby/object:Gem::Version
74
+ version: '0'
75
+ description:
76
+ email:
77
+ - patrick.marsceill@gmail.com
78
+ executables: []
79
+ extensions: []
80
+ extra_rdoc_files: []
81
+ files:
82
+ - LICENSE
83
+ - README.md
84
+ - _layouts/default.html
85
+ homepage: https://github.com/moonharelabs/styless
86
+ licenses:
87
+ - Unlicense
88
+ metadata:
89
+ plugin_type: theme
90
+ post_install_message:
91
+ rdoc_options: []
92
+ require_paths:
93
+ - lib
94
+ required_ruby_version: !ruby/object:Gem::Requirement
95
+ requirements:
96
+ - - ">="
97
+ - !ruby/object:Gem::Version
98
+ version: '0'
99
+ required_rubygems_version: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ requirements: []
105
+ rubygems_version: 3.0.3
106
+ signing_key:
107
+ specification_version: 4
108
+ summary: The Unstyled Jekyll Theme.
109
+ test_files: []