Skip to content

Commit 5ff1b9e

Browse files
EnriquezDanielEnriquezDaniel
committed
Add basic theme
1 parent 82b0fff commit 5ff1b9e

File tree

117 files changed

+103156
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+103156
-0
lines changed

‎.gitignore

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

‎404.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
permalink: /404.html
3+
title: "404: Page not found"
4+
layout: default
5+
sitemap: false
6+
---
7+
8+
<article>
9+
<header><h1>404</h1></header>
10+
<p>Page not found</p>
11+
</article>

‎Gemfile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
source "https://rubygems.org"
2+
3+
gem "jekyll", "~> 4.2.0"
4+
5+
group :jekyll_plugins do
6+
gem "jekyll-feed", "~> 0.12"
7+
end

‎README.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: "About"
3+
permalink: "/about/"
4+
layout: page
5+
---
6+
7+
## Installation
8+
9+
Just fork this [repository](https://github.com/niklasbuschmann/contrast) and adjust the `_config.yml` to use with [Github Pages](https://pages.github.com/) and your page is done.
10+
11+
## Features
12+
13+
- supports dark mode on macOS Mojave
14+
- optional sidebar
15+
- MathJax support
16+
- no external ressources
17+
- included archive page
18+
- supports pagination
19+
- feed generation
20+
- responsive
21+
- syntax highlighting
22+
- supports comments via [disqus](https://disqus.com/) or [isso](http://posativ.org/isso/)
23+
24+
## Based on
25+
26+
- [Hyde](https://github.com/poole/hyde)
27+
- [Minima](https://github.com/jekyll/minima)
28+
- [Lagrange](https://github.com/LeNPaul/Lagrange)
29+
- [Font Awesome](http://fontawesome.io/)
30+
- [KaTeX](https://katex.org/)
31+
- [Pygments](https://github.com/richleland/pygments-css)
32+
33+
## Installation (jekyll-remote-theme method)
34+
35+
You can use this theme with the `jekyll-remote-theme` plugin. Just create an empty repo, copy over the `index.html` file and add this to your `_config.yml`:
36+
37+
```yaml
38+
remote_theme: niklasbuschmann/[email protected]
39+
40+
plugins:
41+
- jekyll-remote-theme
42+
```
43+
44+
Note: to enable icons you also need to copy over the `_data` folder.
45+
46+
## Config
47+
48+
Your `_config.yml` could for example look like this:
49+
50+
```yaml
51+
title: "Blog Title"
52+
author: "Blog Author"
53+
description: "My personal blog about ... something"
54+
permalink: /:title/
55+
lang: "en"
56+
excerpt_separator: "\n\n\n"
57+
date_format: "%B %d, %Y"
58+
59+
# Layout
60+
61+
show_excerpts: true # show article excerpts on the home page
62+
show_frame: true # adds a gray frame to the site
63+
show_sidebar: false # show a sidebar instead of the usual header
64+
65+
# Menu
66+
67+
navigation: # accepts {file, title, url, icon, sidebaricon}
68+
- {file: "index.html"}
69+
- {file: "README.md"}
70+
71+
external: # shows a footer with social links - for available icons see fontawesome.com/icons
72+
- {title: Mail, icon: envelope, url: "mailto:[email protected]"}
73+
- {title: Github, icon: github, url: "https://github.com/niklasbuschmann/contrast"}
74+
- {title: Subscribe, icon: rss, url: "/feed.xml"}
75+
76+
comments:
77+
# disqus_shortname: "" # see https://disqus.com/
78+
# isso_domain: "" # see https://posativ.org/isso/
79+
80+
plugins:
81+
- jekyll-feed
82+
83+
```
84+
85+
## MathJax
86+
87+
Contrast comes preinstalled with a leightweight alternative to MathJax called [KaTeX](https://katex.org/). To display equations in a post simply set `mathjax: true` in the article's front matter.
88+
89+
## License
90+
91+
[public domain](http://unlicense.org/)
92+
93+
## Screenshots
94+
95+
![screenshot](https://user-images.githubusercontent.com/4943215/109431850-cd711780-7a08-11eb-8601-2763f2ee6bb4.png)
96+
97+
![screenshot](https://user-images.githubusercontent.com/4943215/109431832-b6cac080-7a08-11eb-9c5e-a058680c23a1.png)
98+
99+
![screenshot](https://user-images.githubusercontent.com/4943215/73125194-5f0b8b80-3fa4-11ea-805c-8387187503ad.png)

‎UNLICENSE.txt

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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 <http://unlicense.org>

‎_config.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
title: "Blog Title"
2+
author: "Blog Author"
3+
description: "Made with <b style=\"color: #f45;\">&lt;3</b>"
4+
permalink: /:title/
5+
lang: "en"
6+
excerpt_separator: "\n\n\n"
7+
date_format: "%B %d, %Y"
8+
9+
# Layout
10+
11+
show_excerpts: true # show article excerpts on the home page
12+
show_frame: true # adds a gray frame to the site
13+
show_sidebar: false # show a sidebar instead of the usual header
14+
minimal: false # use a dark header
15+
16+
# Menu
17+
18+
navigation: # accepts {file, title, url, icon, sidebaricon}
19+
- {file: "index.html"}
20+
- {file: "README.md"}
21+
22+
external: # shows a footer with social links - for available icons see fontawesome.com/icons
23+
- {title: Mail, icon: envelope, url: "mailto:[email protected]"}
24+
- {title: Github, icon: github, url: "https://github.com/niklasbuschmann/contrast"}
25+
- {title: Subscribe, icon: rss, url: "/feed.xml"}
26+
27+
comments:
28+
# disqus_shortname: "" # see https://disqus.com/
29+
# isso_domain: "" # see https://posativ.org/isso/
30+
31+
plugins:
32+
- jekyll-feed

‎_data/font-awesome/LICENSE.txt

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Font Awesome Free License
2+
-------------------------
3+
4+
Font Awesome Free is free, open source, and GPL friendly. You can use it for
5+
commercial projects, open source projects, or really almost whatever you want.
6+
Full Font Awesome Free license: https://fontawesome.com/license/free.
7+
8+
# Icons: CC BY 4.0 License (https://creativecommons.org/licenses/by/4.0/)
9+
In the Font Awesome Free download, the CC BY 4.0 license applies to all icons
10+
packaged as SVG and JS file types.
11+
12+
# Fonts: SIL OFL 1.1 License (https://scripts.sil.org/OFL)
13+
In the Font Awesome Free download, the SIL OFL license applies to all icons
14+
packaged as web and desktop font files.
15+
16+
# Code: MIT License (https://opensource.org/licenses/MIT)
17+
In the Font Awesome Free download, the MIT license applies to all non-font and
18+
non-icon files.
19+
20+
# Attribution
21+
Attribution is required by MIT, SIL OFL, and CC BY licenses. Downloaded Font
22+
Awesome Free files already contain embedded comments with sufficient
23+
attribution, so you shouldn't need to do anything additional when using these
24+
files normally.
25+
26+
We've kept attribution comments terse, so we ask that you do not actively work
27+
to remove them from files, especially code. They're a great way for folks to
28+
learn about Font Awesome.
29+
30+
# Brand Icons
31+
All brand icons are trademarks of their respective owners. The use of these
32+
trademarks does not indicate endorsement of the trademark holder by Font
33+
Awesome, nor vice versa. **Please do not use brand logos for any purpose except
34+
to represent the company, product, or service to which they refer.**

0 commit comments

Comments
 (0)