2022-02-20 15:15:38 +01:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta http-equiv = "X-UA-Compatible" content = "ie=edge" >
2022-02-23 01:34:48 +01:00
< link rel = "stylesheet" href = "../../../static/styles.css?h=ca3aba42" >
2022-02-20 15:15:38 +01:00
< link rel = "stylesheet" href = "../../../static/pygments.css" >
< link rel = "shortcut icon" href = "../../../static/favicon.png?h=fa09bedd" >
< title > Creating a Theme | Documentation | Lektor Static Content Management System< / title >
< / head >
< body class = "default" >
< nav class = "navbar navbar-inverse navbar-static-top" >
< div class = "container" >
< div class = "navbar-header" >
< button type = "button" class = "navbar-toggle collapsed"
data-toggle="collapse" data-target="#navbar"
aria-expanded="false" aria-controls="navbar">
< span class = "sr-only" > Toggle navigation< / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "navbar-brand" href = "../../../" > Lektor< / a >
< / div >
< div id = "navbar" class = "collapse navbar-collapse" >
< ul class = "nav navbar-nav" >
< li > < a href = "../../../downloads/" > Download< / a > < / li >
< li class = "active" > < a href = "../../" > Documentation< / a > < / li >
< li > < a href = "../../../showcase/" > Showcase< / a > < / li >
< li > < a href = "../../../plugins/" > Plugins< / a > < / li >
< li > < a href = "../../../community/" > Community< / a > < / li >
< li > < a href = "../../../blog/" > Blog< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< div class = "body-wrapper" >
< div class = "container" >
< div class = "row" >
< div class = "col-sm-3" >
< ul class = "tree-nav nocontent" >
< li > < a href = "../../" > Welcome< / a > < / li >
< li > < a href = "../../what/" > What is Lektor< / a >
< li > < a href = "../../installation/" > Installation< / a >
< li > < a href = "../../quickstart/" > Quickstart< / a >
< li > < a href = "../../project/" > Project< / a >
< li > < a href = "../../content/" > Content< / a >
< li > < a href = "../../templates/" > Templates< / a >
< li > < a href = "../" > Themes< / a >
< ul >
< li > < a href = "../installing/" > Installing a Theme< / a >
< li > < a href = "../customizing/" > Customizing a Theme< / a >
< li class = "active" > < a href = "./" > Creating a Theme< / a >
< ul > < / ul >
< li > < a href = "../packages/" > Installing Plugins with a Theme.< / a >
< / ul >
< li > < a href = "../../guides/" > Guides< / a >
< li > < a href = "../../deployment/" > Deployment< / a >
< li > < a href = "../../plugins/" > Plugins< / a >
< li > < a href = "../../models/" > Data Modelling< / a >
< li > < a href = "../../cli/" > Command Line< / a >
< li > < a href = "../../api/" > API< / a >
< li > < a href = "../../search/" > Search< / a >
< / ul >
< div class = "visible-md-block visible-lg-block" >
< h4 > This Page< / h4 >
< ul class = "toc" >
< li > < a href = "#theme-components" > Theme Components:< / a > < / li >
< li > < a href = "#the-theme-settings-variable" > The theme_settings Variable< / a > < / li >
< li > < a href = "#the-theme-ini-file" > The theme.ini File< / a > < / li >
< li > < a href = "#releasing-a-theme" > Releasing a Theme< / a > < / li >
< / ul >
< / div >
< / div >
< div class = "col-sm-9 doc-styling" >
< h1 > Creating a Theme< / h1 >
< ul class = page-meta >
< / ul >
< div class = "admonition admonition-warning" > < p > Not implemented yet.< / p > < / div > < p > You could create a basic empty theme with the following command:< / p >
2022-02-23 01:16:10 +01:00
< div class = "highlight" > < pre > < span > < / span > $ lektor dev new-theme
2022-02-20 15:15:38 +01:00
< / pre > < / div >
< h2 id = "theme-components" > Theme Components:< / h2 > < p > A theme could provide templates, assets, and models (also flowblocks):< / p >
< pre > < code > demo-theme
├── assets
├── models
├── templates
└── flowblocks
< / code > < / pre >
< h2 id = "the-theme-settings-variable" > The theme_settings Variable< / h2 > < p > A < code > theme_settings< / code > section in < code > .lektorproject< / code > file could be used to
parametrize themes:< / p >
2022-02-23 01:16:10 +01:00
< div class = "highlight" > < pre > < span > < / span > < span class = "k" > [theme_settings]< / span > < span class = "w" > < / span >
2022-02-20 15:15:38 +01:00
< span class = "na" > name< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > " Lektor" < / span > < span class = "w" > < / span >
< span class = "na" > github_url< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > " https://github.com/lektor" < / span > < span class = "w" > < / span >
< / pre > < / div >
< p > And those settings will be accessed in templates through the config env
variable:< / p >
2022-02-23 01:16:10 +01:00
< div class = "highlight" > < pre > < span > < / span > < span class = "cp" > {{< / span > < span class = "nv" > config.theme_settings< / span > < span class = "err" > .< / span > < span class = "o" > < < / span > < span class = "nv" > variable_name< / span > < span class = "o" > > < / span > < span class = "cp" > }}< / span > < span class = "x" > < / span >
2022-02-20 15:15:38 +01:00
< / pre > < / div >
< p > Example:< / p >
2022-02-23 01:16:10 +01:00
< div class = "highlight" > < pre > < span > < / span > < span class = "x" > < a href=" < / span > < span class = "cp" > {{< / span > < span class = "nv" > config.theme_settings.github_url< / span > < span class = "cp" > }}< / span > < span class = "x" > " > Github< /a> < / span >
2022-02-20 15:15:38 +01:00
< / pre > < / div >
< p > will output:< / p >
< pre > < code > < a href="https://github.com/lektor/lektor"> Github< /a>
< / code > < / pre >
< h2 id = "the-theme-ini-file" > The theme.ini File< / h2 > < p > Themes could provide a < code > theme.ini< / code > file, that is optional, but it's required if
you want to add your theme to the lektor community themes.< / p >
< p > Example:< / p >
2022-02-23 01:16:10 +01:00
< div class = "highlight" > < pre > < span > < / span > < span class = "k" > [theme]< / span > < span class = "w" > < / span >
2022-02-20 15:15:38 +01:00
< span class = "na" > name< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > Demo theme< / span > < span class = "w" > < / span >
< span class = "na" > license< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > MIT< / span > < span class = "w" > < / span >
< span class = "na" > licenselink< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > https://github.com/lektor/lektor-demo-theme/blob/master/LICENSE.md< / span > < span class = "w" > < / span >
< span class = "na" > description< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > Simple, minimal theme for Lektor< / span > < span class = "w" > < / span >
< span class = "na" > homepage< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > https://github.com/lektor/lektor-demo-theme< / span > < span class = "w" > < / span >
< span class = "na" > tags< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > simple, minimal, demo< / span > < span class = "w" > < / span >
< span class = "na" > features< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > blog< / span > < span class = "w" > < / span >
< span class = "na" > lektor_minimum_required_version< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > 3.1< / span > < span class = "w" > < / span >
< span class = "k" > [author]< / span > < span class = "w" > < / span >
< span class = "na" > name< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > lektor< / span > < span class = "w" > < / span >
< span class = "na" > homepage< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > http://getlektor.com/< / span > < span class = "w" > < / span >
< span class = "k" > [original]< / span > < span class = "w" > < / span >
< span class = "na" > author< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span >
< span class = "na" > homepage< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span >
< span class = "na" > repo< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span >
< span class = "k" > [packages]< / span > < span class = "w" > < / span >
< span class = "na" > lektor-disqus-comments< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > 0.2< / span > < span class = "w" > < / span >
< / pre > < / div >
< p > The < code > [original]< / code > section is only required if you are porting an existing theme.< / p >
< div class = "admonition admonition-warning" > < p > Not implemented yet< / p > < / div > < p > The < code > lektor_minimum_required_version< / code > is used by Lektor to check the
compatibility when installing a theme.< / p >
< h2 id = "releasing-a-theme" > Releasing a Theme< / h2 > < div class = "admonition admonition-warning" > < p > Not implemented yet< / p > < / div > < p > You could add a theme to Lektor community theme, open a pull request against
< a href = "https://github.com/lektor/lektor-themes" > lektor themes< / a > adding it as a git
submodule.< / p >
< p > You should also include an < code > images/< / code > folder with a screenshot and a thumbnail:< / p >
< pre > < code > demo-theme
└── images
├── thumbnail.png
└── screenshot.png
< / code > < / pre >
< p > Themes added to this lektor-themes repository, will automatically be added to the
lektor website.< / p >
< div class = "comment-box" >
< h2 > Comments< / h2 >
< div id = "disqus_thread" > < / div >
< script >
var disqus_config = function() { this.page.identifier = "/docs/themes/creating"; this.page.url = "https://www.getlektor.com/docs/themes/creating/"; };
(function() {
var d = document, s = d.createElement('script');
s.src = '//lektordocumentation.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
< / script >
< noscript >
Please enable JavaScript to view the < a href = "https://disqus.com/?ref_noscript"
rel="nofollow">comments powered by Disqus.< / a >
< / noscript >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "bottomsummary" >
< div class = "container" >
< / div >
< / div >
< footer >
< div class = "container" >
< div class = "row" >
< div class = "col-sm-4 icon-bar" >
< a href = "https://github.com/lektor/lektor/" title = "Lektor on GitHub"
>< i class = "fa fa-github" > < / i > < / a >
< a href = "https://github.com/lektor/lektor/issues/" title = "Report Issues for Lektor"
>< i class = "fa fa-bug" > < / i > < / a >
< a href = "https://twitter.com/getlektor" title = "Find Lektor on Twitter"
>< i class = "fa fa-twitter" > < / i > < / a >
< a href = "https://gitter.im/lektor/lektor" title = "Chat on Gitter"
>< i class = "fa fa-comment" > < / i > < / a >
< a href = "https://github.com/lektor/lektor-website/tree/master/content/docs/themes/creating/contents.lr" title = "View source for this page" > < i class = "fa fa-code" > < / i > < / a >
< / div >
< div class = "col-sm-8" >
< a href = "../../../license/" > License & Copyright< / a > •
< a href = "../../../contact/" > Contact< / a > •
Made with < i class = "fa fa-fw fa-heart" title = "Heart" > < span hidden > Heart< / span > < / i > in Carinthia
< / div >
< / div >
< / div >
< / footer >
2022-02-23 01:34:48 +01:00
< script type = text/javascript src = "../../../static/app.js?h=bb1b933a" charset = "utf-8" > < / script >
2022-02-20 15:15:38 +01:00
< script >
((window.gitter = {}).chat = {}).options = {
room: 'lektor/lektor',
activationElement: null
};
document.write('< button class = "js-gitter-toggle-chat-button" > Toggle Chat< / button > ');
var dnt = navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack;
if (dnt != "1" & & dnt != "yes") {
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
ga('create', 'UA-70822533-1', 'auto');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
} else {
console.debug("Respecting Do-Not-Track, not running analytics.");
}
< / script >
< script async src = 'https://www.google-analytics.com/analytics.js' > < / script >
< script async defer id = "github-bjs" src = "https://buttons.github.io/buttons.js" > < / script >
< script > ! function ( d , s , id ) { var js , fjs = d . getElementsByTagName ( s ) [ 0 ] , p = /^http:/ . test ( d . location ) ? 'http' : 'https' ; if ( ! d . getElementById ( id ) ) { js = d . createElement ( s ) ; js . id = id ; js . src = p + '://platform.twitter.com/widgets.js' ; fjs . parentNode . insertBefore ( js , fjs ) ; } } ( document , 'script' , 'twitter-wjs' ) ; < / script >
< script src = "https://sidecar.gitter.im/dist/sidecar.v1.js" async defer > < / script >
< / body >
< / html >
