jekyll-kde-theme¶ ↑
This is a jekyll theme for a unified layout across the kde websites.
Installation¶ ↑
To create a new website, copy the directory examples/simple
And repace
gem "jekyll-kde-theme", path: '../../'
by
gem "jekyll-kde-theme"
And then execute:
$ bundle install --path vendor/bundle
You can now start editing the website.
To test your change do:
$ bundle exec jekyll server
You can also find a tutorial in the community wiki: community.kde.org/KDE.org/Jekyll
Usage¶ ↑
Collections:¶ ↑
-
Changelogs (optional): put the software changelog in _changelogs. Example metadata:
“`¶ ↑
layout: changelog title: Konsole 1.1.1 / KDE 3.0.1 sorted: 3001 # version for sorting css-include: /css/main.css
-
Feature 1
-
Feature 2
“`
Blog¶ ↑
In _config.yml
, put
paginate: 3
And in the index.html
page, you can include the blog component.
{% include blog.html %}
Options¶ ↑
Following options are available in _config.yml
-
app_icon
: Path to the icon displayed in the navbar -
navigation
: Navigation menu settings -
navigation.top[].title
: Title for the top navigation menu item -
navigation.top[].url
: URL for the top navigation menu item -
navigation.bottom[].name
: Section title for the bottom links-
navigation.bottom[].items[].title
: Title for the bottom links -
navigation.bottom[].items[].url
: URL for the bottom links
-
navigation
option example:
navigation: top: - title: Changelog url: /changelog.html - title: Download url: /download.html bottom: - name: Community items: - title: Konsole Forums url: https://forum.kde.org/viewforum.php?f=227&sid=2e54340bf2c58589fec0f3406a4ce171 - name: News & Press items: - title: Announcements url: https://www.kde.org/announcements/ - title: KDE.news url: https://dot.kde.org/
Build example¶ ↑
cd example/simple bundle install --path vendor/bundle bundle exec jekyll serve
Contributing¶ ↑
Bug reports and pull requests are welcome on the KDE Gitlab at invent.kde.org/websites/jekyll-kde-theme.
Development¶ ↑
To set up your environment to develop this theme, run bundle install
.
Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve
and open your browser at http://localhost:4000
. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in _layouts
, _includes
, _sass
and assets
tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in jekyll-kde-theme.gemspec
accordingly.
License¶ ↑
This program is licensed under the GNU AGPL. See KDE Licensing policy.