arrow-jekyll-theme 0.1.0 → 0.1.1
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 +4 -4
- data/Devlog.md +19 -1
- data/README.md +83 -16
- data/_includes/footer.html +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 151bb8e10189c88e94e834ba89de8b73d08119e494e8e2f91efd9da8ffa5edb3
|
|
4
|
+
data.tar.gz: fee13e4696332c425a55c2844b462ab1ee87f7c687b76acb9b1810400e944fe6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: dbe27a54785d00b5e19db6199d6df8c7cb7d854d09c54d268b4b989c23e5d13c62743220657f00fccf68d3f47dc066f37e04264f8c29bb1851b652dfa5f7548a
|
|
7
|
+
data.tar.gz: dedadcd457cf589225245c49ad0d670241bf753df6bf13fd17cf01c1ebfe91a2230914f6a872dfcfa95bb0025acd31323bbf5d5bac8d444ea95a7f7dd212a6cb
|
data/Devlog.md
CHANGED
|
@@ -36,6 +36,9 @@ Note: To include default index.md, posts.md, and devlog.md, I had to update the
|
|
|
36
36
|
spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r!^(assets|_data|_layouts|_includes|_sass|LICENSE|README|_config\.yml|Devlog\.md|index\.md|posts\.md)!i) }
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
+
<time class="timestamp--time">06:32 AM</time>
|
|
40
|
+
**Update**: These files are not automatically included, so I will make sure to note that in the README.md
|
|
41
|
+
|
|
39
42
|
## Building Gem
|
|
40
43
|
|
|
41
44
|
```shell
|
|
@@ -71,9 +74,24 @@ gem "arrow-jekyll-theme"
|
|
|
71
74
|
And then execute:
|
|
72
75
|
|
|
73
76
|
```shell
|
|
74
|
-
$ bundle
|
|
77
|
+
$ bundle install
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Finding where gem was installed
|
|
81
|
+
|
|
82
|
+
```shell
|
|
83
|
+
$ bundle info arrow-jekyll-theme
|
|
75
84
|
```
|
|
76
85
|
|
|
86
|
+
## Build Your Site
|
|
87
|
+
|
|
88
|
+
```shell
|
|
89
|
+
$ bundle exec jekyll serve
|
|
90
|
+
```
|
|
77
91
|
|
|
92
|
+
<time class="timestamp--time">07:03 AM</time>
|
|
93
|
+
I just published the gem to RubyGems [here](https://rubygems.org/gems/arrow-jekyll-theme)
|
|
78
94
|
|
|
79
95
|
|
|
96
|
+
<time class="timestamp--time">07:22 AM</time>
|
|
97
|
+
I just noticed I forgot to update the link to the RSS feed. Fixing and pushing an update right now.
|
data/README.md
CHANGED
|
@@ -1,50 +1,117 @@
|
|
|
1
1
|
# Arrow
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Arrow is a text-first Jekyll theme featuring minimal CSS by relying on default browser stylesheets to produce highly readable, responsive websites and blogs.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
TODO: Delete this and the text above, and describe your gem
|
|
5
|
+
|
|
8
6
|
|
|
9
7
|
## Installation
|
|
10
8
|
|
|
11
9
|
Add this line to your Jekyll site's `Gemfile`:
|
|
12
10
|
|
|
13
11
|
```ruby
|
|
14
|
-
gem "
|
|
12
|
+
gem "arrow-jekyll-theme"
|
|
15
13
|
```
|
|
16
14
|
|
|
17
15
|
And add this line to your Jekyll site's `_config.yml`:
|
|
18
16
|
|
|
19
17
|
```yaml
|
|
20
|
-
theme:
|
|
18
|
+
theme: arrow-jekyll-theme
|
|
21
19
|
```
|
|
22
20
|
|
|
23
21
|
And then execute:
|
|
24
22
|
|
|
25
|
-
$ bundle
|
|
23
|
+
$ bundle install
|
|
26
24
|
|
|
27
25
|
Or install it yourself as:
|
|
28
26
|
|
|
29
|
-
$ gem install
|
|
27
|
+
$ gem install arrow-jekyll-theme
|
|
30
28
|
|
|
31
29
|
## Usage
|
|
32
30
|
|
|
33
|
-
|
|
31
|
+
After installing the theme, you should copy the default markdown files into your Jekyll site.
|
|
34
32
|
|
|
35
|
-
|
|
33
|
+
```bash
|
|
34
|
+
cp -r path/to/arrow-jekyll-theme/*.md path/to/your-jekyll-site/
|
|
35
|
+
```
|
|
36
36
|
|
|
37
|
-
|
|
37
|
+
To find the correct path, run:
|
|
38
|
+
|
|
39
|
+
```shell
|
|
40
|
+
$ bundle info arrow-jekyll-theme
|
|
41
|
+
```
|
|
38
42
|
|
|
39
|
-
|
|
43
|
+
This will add the following files to your site:
|
|
40
44
|
|
|
41
|
-
|
|
45
|
+
- index.md
|
|
46
|
+
- about.md
|
|
47
|
+
- post.md
|
|
48
|
+
- devlog.md
|
|
49
|
+
|
|
50
|
+
Feel free to change or delete any of these files as you see fit.
|
|
42
51
|
|
|
43
52
|
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.
|
|
44
53
|
|
|
45
|
-
|
|
46
|
-
|
|
54
|
+
## Layouts
|
|
55
|
+
|
|
56
|
+
By default, you will find three layout files:
|
|
57
|
+
|
|
58
|
+
- default.html
|
|
59
|
+
- page.html
|
|
60
|
+
- post.html
|
|
61
|
+
|
|
62
|
+
The only difference between the page and post layouts is for displaying the date. The devlog is built using the page layout.
|
|
63
|
+
|
|
64
|
+
## Utility Classes
|
|
65
|
+
|
|
66
|
+
To make writing devlogs easier, the theme includes a couple of CSS utility classes:
|
|
67
|
+
|
|
68
|
+
- `.timestamp--time`
|
|
69
|
+
- `.timestamp--date`
|
|
70
|
+
|
|
71
|
+
For example, you can add a `<time>` element above a paragraph:
|
|
72
|
+
|
|
73
|
+
```html
|
|
74
|
+
<time class="timestamp--time">10:08 PM</time>
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
This will create a small timestamp element above paragraphs. This was created with the use of [TextMate Snippets](https://macromates.com/textmate/manual/snippets) in mind, but surely the functionality can be replicated with your text editor of choice.
|
|
78
|
+
|
|
79
|
+
## CSS
|
|
80
|
+
|
|
81
|
+
The CSS theme is minimal, mostly to improve readability and accessibility. There are three CSS files in the project.
|
|
82
|
+
|
|
83
|
+
- base.css
|
|
84
|
+
- article.css
|
|
85
|
+
- monokai.css
|
|
86
|
+
|
|
87
|
+
In the `base.css` file you will find variable definitions, media queries, and utility classes. The `article.css` file includes custom classes for styling blog posts. Custom CSS classes follow the [BEM methodology](https://en.bem.info/methodology/css/).
|
|
88
|
+
|
|
89
|
+
## Syntax Highlighting
|
|
90
|
+
|
|
91
|
+
By default, Arrow uses the Monokai [rouge](https://github.com/rouge-ruby/rouge) theme by inclusion of a CSS file from this list of [themes](https://github.com/brazacz/rouge-themes). These can be updated or deleted by following the instructions in the following section.
|
|
92
|
+
|
|
93
|
+
## Overriding Default Files
|
|
94
|
+
|
|
95
|
+
To override any theme file, you can either create it in your local development environment or update it directly by finding where bundle has installed the gem.
|
|
96
|
+
|
|
97
|
+
To do so, you must run:
|
|
98
|
+
|
|
99
|
+
```shell
|
|
100
|
+
$ bundle info arrow-jekyll-theme
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Uninstalling
|
|
104
|
+
|
|
105
|
+
To uninstall the theme using bundler:
|
|
106
|
+
|
|
107
|
+
```shell
|
|
108
|
+
$ gem uninstall arrow-jekyll-theme
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Contributing
|
|
112
|
+
|
|
113
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/cspablocortez/arrow-jekyll-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
|
|
47
114
|
|
|
48
115
|
## License
|
|
49
116
|
|
|
50
|
-
The theme is available as open source under the terms of the [
|
|
117
|
+
The theme is available as open source under the terms of the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text).
|
data/_includes/footer.html
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
<li><a href="/posts">Posts</a></li>
|
|
6
6
|
<li><a href="/about">About</a></li>
|
|
7
7
|
<li><a href="/devlog">Devlog</a></li>
|
|
8
|
-
<li><a href="
|
|
8
|
+
<li><a href="/feed.xml">RSS</a></li>
|
|
9
9
|
</ul>
|
|
10
10
|
<small>
|
|
11
11
|
The <a href="https://github.com/cspablocortez/arrow-jekyll-theme">code for this project</a>
|