Theme Update
This commit is contained in:
parent
532b7b351a
commit
b8c8e24ea1
87
README.md
87
README.md
@ -1,10 +1,87 @@
|
|||||||

|

|
||||||
|
|
||||||
## Installation
|
The theme is keeped as simple as possible on purpose. There are no fancy headers, cards, or stuff like that.
|
||||||
git..
|
The fonts in use are Literata and Monaspace.
|
||||||
|
|
||||||
## Features
|
Tags are intentionally omitted, have a look at the sample coinfiguration at the bottom to remove them.
|
||||||
...
|
|
||||||
|
## Example website
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
To receive updates, add the theme as a submodule:
|
||||||
|
```
|
||||||
|
git submodule add git@github.com:tomfran/typo.git themes/typo
|
||||||
|
```
|
||||||
|
|
||||||
|
Otherwise you can clone the repo and copy it manually to yout theme folder.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
...
|
|
||||||
|
Here is an example configuration:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
baseURL = 'https://example.org/'
|
||||||
|
languageCode = 'en-us'
|
||||||
|
disableKinds = ['taxonomy']
|
||||||
|
title = 'Title'
|
||||||
|
theme = 'Typo'
|
||||||
|
|
||||||
|
googleAnalytics = "G-XXXXXXXXX"
|
||||||
|
|
||||||
|
|
||||||
|
[params]
|
||||||
|
# Math mode
|
||||||
|
math = true
|
||||||
|
|
||||||
|
# Intro on main page, content in markdown
|
||||||
|
homeIntro = true
|
||||||
|
homeIntroTitle = 'Hi!'
|
||||||
|
homeIntroContent = """
|
||||||
|
Here is my blog, this supports markdown:
|
||||||
|
- a
|
||||||
|
- b
|
||||||
|
- c
|
||||||
|
"""
|
||||||
|
|
||||||
|
# Collection to display on home
|
||||||
|
homeCollectionTitle = 'Posts'
|
||||||
|
homeCollection = 'posts'
|
||||||
|
|
||||||
|
# Pagination size across all website
|
||||||
|
paginationSize = 100
|
||||||
|
|
||||||
|
# Social icons
|
||||||
|
[[params.social]]
|
||||||
|
name = "linkedin"
|
||||||
|
url = "https://www.linkedin.com/in/"
|
||||||
|
|
||||||
|
[[params.social]]
|
||||||
|
name = "medium"
|
||||||
|
url = "https://medium.com/"
|
||||||
|
|
||||||
|
[[params.social]]
|
||||||
|
name = "github"
|
||||||
|
url = "https://github.com/"
|
||||||
|
|
||||||
|
|
||||||
|
# Main menu pages
|
||||||
|
[[params.menu]]
|
||||||
|
name = "home"
|
||||||
|
url = "/"
|
||||||
|
|
||||||
|
[[params.menu]]
|
||||||
|
name = "posts"
|
||||||
|
url = "/posts"
|
||||||
|
|
||||||
|
[[params.menu]]
|
||||||
|
name = "about"
|
||||||
|
url = "/about"
|
||||||
|
|
||||||
|
# Syntax highligth on code blocks
|
||||||
|
[markup]
|
||||||
|
[markup.highlight]
|
||||||
|
style = 'algol'
|
||||||
|
```
|
@ -4,7 +4,7 @@
|
|||||||
--main-padding-bottom: 3rem;
|
--main-padding-bottom: 3rem;
|
||||||
|
|
||||||
/* header settings */
|
/* header settings */
|
||||||
--header-top-gap: 1.5rem;
|
--header-top-gap: 2rem;
|
||||||
--header-bottom-gap: 2rem;
|
--header-bottom-gap: 2rem;
|
||||||
--header-menu-side-gap: .5rem;
|
--header-menu-side-gap: .5rem;
|
||||||
--header-menu-top-gap: 1rem;
|
--header-menu-top-gap: 1rem;
|
||||||
|
Loading…
Reference in New Issue
Block a user