diff --git a/readme.md b/readme.md index ab98fbd..e5f434c 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,34 @@ # jekyll-theme-basic -An incredibly rudimentary jekyll theme. Paper-thin, nothing but what's needed. \ No newline at end of file +An incredibly rudimentary jekyll theme. Paper-thin, nothing but what's needed for HTML. + +You can see it up and running on my [blog](https://atlas48.sdf.org/) and my [website](https://atlas48.neocities.org), which this theme was originally made for. + +## Config + +This theme has a few options that one may use. Every option is under the `basic_theme` hierachy. + +### `header_links` + +`Array[2]>` + +An array of objects with two keys, `href` & `name`. Each sub-object describes a certain link element you want +on the top of the page. + +**Example:** +```yaml +basic: + header_links: + - href: https://github.com/Atlas48 + name: GitHub + - href: https://atlas48.neocities.org/ + name: The Archives + - href: https://mastodon.sdf.org/@atlas48 + name: Mastodon +``` + +### `display_title` + +`bool` + +Wherever or not to display the site's title at the top of the page. \ No newline at end of file