Skip to content

Commit 1f57ea1

Browse files
emilbaehremilbaehr
committed
First commit (create skeleton)
0 parents  commit 1f57ea1

File tree

10 files changed

+110
-0
lines changed

10 files changed

+110
-0
lines changed

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
*.gem
2+
.bundle
3+
.sass-cache
4+
_site
5+
Gemfile.lock

‎Gemfile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
gemspec

‎README.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# jekyll-start
2+
3+
Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
4+
5+
To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
6+
7+
TODO: Delete this and the text above, and describe your gem
8+
9+
10+
## Installation
11+
12+
Add this line to your Jekyll site's `Gemfile`:
13+
14+
```ruby
15+
gem "jekyll-start"
16+
```
17+
18+
And add this line to your Jekyll site's `_config.yml`:
19+
20+
```yaml
21+
theme: jekyll-start
22+
```
23+
24+
And then execute:
25+
26+
$ bundle
27+
28+
Or install it yourself as:
29+
30+
$ gem install jekyll-start
31+
32+
## Usage
33+
34+
TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
35+
36+
## Contributing
37+
38+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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.
39+
40+
## Development
41+
42+
To set up your environment to develop this theme, run `bundle install`.
43+
44+
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.
45+
46+
When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
47+
To add a custom directory to your theme-gem, please edit the regexp in `jekyll-start.gemspec` accordingly.
48+
49+
## License
50+
51+
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
52+

‎_includes/footer.html‎

Whitespace-only changes.

‎_includes/head.html‎

Whitespace-only changes.

‎_includes/header.html‎

Whitespace-only changes.

‎_layouts/default.html‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!DOCTYPE html>
2+
<html>
3+
{% include head.html %}
4+
5+
<body>
6+
{% include header.html %}
7+
<main>
8+
<article>
9+
{{ content }}
10+
</article>
11+
{% include footer.html %}
12+
</main>
13+
</body>
14+
15+
</html>

‎_layouts/page.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
layout: default
3+
---
4+
5+
<h2>{{ page.title }}</h2>
6+
7+
{{ content }}

‎_layouts/post.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
layout: default
3+
---
4+
5+
<h2>{{ page.title }}</h2>
6+
<time>{{ page.date | date: "%b %-d, %Y" }}{% if page.author %} • {{ page.author }}{% endif %}{% if page.meta %} • {{ page.meta }}{% endif %}</time>
7+
8+
{{ content }}

‎jekyll-start.gemspec‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# frozen_string_literal: true
2+
3+
Gem::Specification.new do |spec|
4+
spec.name = "jekyll-start"
5+
spec.version = "0.1.0"
6+
spec.authors = ["Emil Baehr"]
7+
spec.email = ["[email protected]"]
8+
9+
spec.summary = "TODO: Write a short summary, because Rubygems requires one."
10+
spec.homepage = "TODO: Put your gem's website or public repo URL here."
11+
spec.license = "MIT"
12+
13+
spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r!^(assets|_layouts|_includes|_sass|LICENSE|README)!i) }
14+
15+
spec.add_runtime_dependency "jekyll", "~> 3.8"
16+
17+
spec.add_development_dependency "bundler", "~> 1.16"
18+
spec.add_development_dependency "rake", "~> 12.0"
19+
end

0 commit comments

Comments
 (0)