Skip to content

Commit

Permalink
update README & overflow fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Niklas Buschmann committed Feb 28, 2021
1 parent 236cd6d commit b087ec2
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 9 deletions.
50 changes: 48 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,59 @@ plugins:
- jekyll-remote-theme
```
Note: to enable icons you also need to copy over the `_data` folder.

## Config

Your `_config.yml` could for example look like this:

```yaml
title: "Blog Title"
author: "Blog Author"
description: "My personal blog about ... something"
permalink: /:title/
lang: "en"
excerpt_separator: "\n\n\n"
date_format: "%B %d, %Y"
# Layout
show_excerpts: true # show article excerpts on the home page
show_frame: true # adds a gray frame to the site
show_sidebar: false # show a sidebar instead of the usual header
# Menu
navigation: # accepts {file, title, url, icon, sidebaricon}
- {file: "index.html"}
- {file: "README.md"}
external: # shows a footer with social links - for available icons see fontawesome.com/icons
- {title: Mail, icon: envelope, url: "mailto:[email protected]"}
- {title: Github, icon: github, url: "https://github.com/niklasbuschmann/contrast"}
- {title: Subscribe, icon: rss, url: "/feed.xml"}
comments:
# disqus_shortname: "" # see https://disqus.com/
# isso_domain: "" # see https://posativ.org/isso/
plugins:
- jekyll-feed
```

## MathJax

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.

## License

[public domain](http://unlicense.org/)

## Screenshots

![screenshot](https://user-images.githubusercontent.com/4943215/73125194-5f0b8b80-3fa4-11ea-805c-8387187503ad.png)
![screenshot](https://user-images.githubusercontent.com/4943215/109431850-cd711780-7a08-11eb-8601-2763f2ee6bb4.png)

![screenshot](https://user-images.githubusercontent.com/4943215/73125195-5fa42200-3fa4-11ea-89f8-d09c1d6fe252.png)
![screenshot](https://user-images.githubusercontent.com/4943215/109431832-b6cac080-7a08-11eb-9c5e-a058680c23a1.png)

![screenshot](https://user-images.githubusercontent.com/4943215/73125194-5f0b8b80-3fa4-11ea-805c-8387187503ad.png)
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
title: "Blog Title"
author: "Blog Author"
description: "Made with <b style=\"color: #f45;\">&lt;3</b>"
description: "My personal blog about ... something"
permalink: /:title/
lang: "en"
excerpt_separator: "\n\n\n"
Expand Down
5 changes: 0 additions & 5 deletions _sass/basic.sass
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,6 @@ table
border-radius: 2px
box-shadow: 0 0 0 1px reduce(12) inset

@media (min-width: 50em)
table
display: table
width: 100%

th, td
padding: .5em 1em
box-shadow: 0 0 0 1px reduce(12)
Expand Down
2 changes: 1 addition & 1 deletion _sass/layout.sass
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ body > header, body > footer

article
flex-grow: 1
overflow-y: auto
overflow-x: auto

article header
margin-bottom: 1.5em
Expand Down

0 comments on commit b087ec2

Please sign in to comment.