A simple link directory Jekyll theme for institutions with many sites.
Add this line to your Jekyll site's Gemfile:
gem "link-directory"And add this line to your Jekyll site's _config.yml:
theme: link-directoryIf you are a GitHub pages user, add this line to your site's _config.yml instead:
remote_theme: epetousis/link-directoryAnd then execute:
$ bundle
Or install it yourself as:
$ gem install link-directory
Here is an example page:
---
layout: links-page
title: An example page
sections:
- type: standard
body:
- name: "A link"
url: https://google.com
width: 1-1
colour: blue
- text: "This is a link to google.com."
- type: small
body:
- text: "This is small text."
---You can easily specify your own sections in the sections sequence, and each item in a section can be either a button or text.
To make your own page, create a folder with your intended link path as the name, and add a file called index.html with a layout similar to the example above.
You can have a small section, a narrow section, or a standard section (this is the default; you don't have to specify it)
Markdown pages can be written easily using GitHub-flavoured Markdown.
---
# Don't change this line, otherwise you'll disable Markdown formatting.
layout: default-markdown
title: Sample page
---
Here is a sample page that will look really good.
**All** the _useful_ Markdown syntax is supported.For more information on how to use Markdown, check out Adam Pritchard's guide on GitHub-flavoured Markdown.
To make your own text page, create a folder with your intended link path as the name, and add a file called index.md with a layout similar to the example above.
Bug reports and pull requests are welcome on GitHub at https://github.com/evilgoldfish/link-directory.
To set up your environment to develop this theme, run bundle install.
To test the theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using the theme.
link-directory is available as open source under the terms of the MIT License.