KDE.org/Neverland
Introduction
KDE's Neverland is able to build full themes from a set of template files. The designer needs to only care about the css/js files and the correct nesting of the layout (html). Once satisfied, complete themes for any supported CMS can be outputted and then used accordingly. The project is based on node.js.
Installation
Requirement
- Git
- NodeJs >= 6.0
- Basic understanding of http://mustache.github.io/mustache.5.html
Installing Neverland
Clone the repository:
git clone git://anongit.kde.org/websites/neverland.git
Cd to the neverland folder:
cd neverland
Switch to gsoc branch:
git checkout gsoc
Install dependencies:
npm install
Install gulp globally:
npm install gulp -g
You can check if everything is ok by running:
node neverland watch --theme neverland
Usage
To create a new theme, you can run:
node neverland new your-theme-name
Your new theme will appear under blueprints directory
To start building a theme, you can run:
node neverland watch --theme your-theme-name
or
gulp watch --theme your-theme-name
Currently you should keep your theme structure by default
Now you can code your theme normally.
To convert your html theme to wordpress or mediawiki theme, you need some additional works. Every theme shares some same parts such as Navigation bar, Category links, Sidebar. In order to let Neverland understand where to transform these parts to corresponding cms part you need to some default Mustache tags.
For example:
You have your navbar like this:
<ul class="header__categories">
<li class="header__categories--item">
<a href="#" class="header__categories--link">Work</a>
</li>
<li class="header__categories--item">
<a href="#" class="header__categories--link">Portfolio</a>
</li>
<li class="header__categories--item">
<a href="#" class="header__categories--link">About</a>
</li>
</ul>
You should insert the tags like this:
<ul class="header__categories">
{{#navbar__category}}
{{&navbar__category}}
<li class="header__categories--item">
<a href="{{&navbar__category--link}}" class="header__categories--link">{{&navbar__category--name}}</a>
</li>
{{&navbar__category--end}}
{{/navbar__category}}
{{^navbar__category}}
<li class="header__categories--item">
<a href="#" class="header__categories--link">Work</a>
</li>
<li class="header__categories--item">
<a href="#" class="header__categories--link">Portfolio</a>
</li>
<li class="header__categories--item">
<a href="#" class="header__categories--link">About</a>
</li>
{{/navbar__category}}
</ul>
There are some key points here:
- Those tags using https://en.bem.info/ methodology
- Template:& is the same as {{{ }}} because Neverland uses https://github.com/janl/mustache.js
- You should define both which part should be transform and default part
You can check for full tags in #Supported Tags section
Finally, you can output your theme to wordpress/mediawiki theme by running:
node neverland build --theme your-theme-name
Your theme will be placed under buildings directory
Commands
node neverland [commands]
| new <theme-name> | Create new skeleton theme |
| delete --theme <theme-name> | Delete theme |
| themes | List existing theme |
| sass --theme <theme-name> | Compile sass files |
| watch --theme <theme-name> | Using gulp watch |
| build --theme <theme-name> --platform,-p <platform> | Build theme for specific platform. If platform is ommited, Neverland will build for all supported platforms. |
Supported Tags
article__link
article__title
article__thumbnail
article__time
article__author--link
article__author--name
article__content
article__category
article__category--end
article__category--link
article__category--name
navbar__category
navbar__category--link
navbar__category--name
navbar__category--endWrite a builder for other platforms
will be updated