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-07-28 05:28:26 +02:00
< link rel = "stylesheet" href = "../../../static/styles.css?h=ae0cc228" >
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 > GitHub Pages | 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/" > Themes< / a >
< li > < a href = "../../guides/" > Guides< / a >
< li > < a href = "../" > Deployment< / a >
< ul >
< li > < a href = "../ftp/" > FTP< / a >
< li class = "active" > < a href = "./" > GitHub Pages< / a >
< ul > < / ul >
< li > < a href = "../glpages/" > GitLab Pages< / a >
< li > < a href = "../rsync/" > rsync< / a >
< li > < a href = "../travisci/" > Travis-CI< / a >
< / ul >
< 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 = "#credentials" > Credentials< / a > < / li >
< li > < a href = "#behavior" > Behavior< / a > < / li >
< li > < a href = "#cname-support" > CNAME Support< / a > < / li >
< li > < a href = "#404-pages" > 404 Pages< / a > < / li >
< li > < a href = "#automatic-deployments" > Automatic Deployments< / a > < / li >
< / ul >
< / div >
< / div >
< div class = "col-sm-9 doc-styling" >
< h1 > GitHub Pages< / h1 >
< ul class = page-meta >
< / ul >
< ul >
< li > < code > ghpages://username/repository< / code > < / li >
< li > < code > ghpages+https://username/repository< / code > < / li >
< / ul >
< p > A popular way to host websites for Open Source projects is the GitHub pages.
It's a free service provided by < a href = "http://github.com/" class = "ext" > GitHub< / a > which allows
to host completely static websites through GitHub.< / p >
< p > The way this is implemented in Lektor currently is that Lektor will force-push
a website into a repository of choice. There are two ways to push it up:
< code > ghpages< / code > (which uses SSH) or < code > ghpages+https< / code > (which uses HTTPS). The latter
can also accept < code > username:password@< / code > in the URL to hold the credentials in
addition to accepting username and password from the command line or
environment variables.< / p >
< p > Example:< / p >
2022-05-03 00:53:59 +02:00
< div class = "hll" > < pre > < span > < / span > < span class = "k" > [servers.ghpages]< / span > < span class = "w" > < / span >
2022-02-20 15:15:38 +01:00
< span class = "na" > target< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > ghpages://your-user/your-repository< / span > < span class = "w" > < / span >
< / pre > < / div >
< h2 id = "credentials" > Credentials< / h2 > < p > This deployment method has two implementations: < code > ghpages< / code > (also known as
< code > ghpages+ssh< / code > ) which uses SSH and < code > ghpages+https< / code > which uses HTTPS. They
use different methods for credentials. For the SSH transport the same
rules apply as for the < a href = "../rsync/" class = "ref" > rsync deployment method< / a > . The HTTPS
transport on the other hand accepts < code > --username< / code > and < code > --password< / code > which
override the values in the URL.< / p >
< div class = "admonition admonition-note" > < p > If you have 2-factor authentication set up and you're using HTTPS, instead of your normal password, you will need to use a < a href = "https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/" class = "ext" > personal access token< / a > .< / p > < / div > < h2 id = "behavior" > Behavior< / h2 > < p > The way this deployment support works is that it commits a new commit into a
temporary location and pushes it into the < code > gh-pages< / code > or < code > master< / code > branch
depending on the name of the repository. If you push to < code > username.github.io< / code >
then it commits to < code > master< / code > , otherwise to < code > gh-pages< / code > . This is consistent
with behavior for GitHub Pages.< / p >
< h2 id = "cname-support" > CNAME Support< / h2 > < p > If you want to use a custom domain with GitHub pages (also known as a
< a href = "https://en.wikipedia.org/wiki/CNAME" class = "ext" > CNAME< / a > ), provide the intended
CNAME in the target URL using the < code > ?cname< / code > parameter:< / p >
2022-05-03 00:53:59 +02:00
< div class = "hll" > < pre > < span > < / span > < span class = "k" > [servers.production]< / span > < span class = "w" > < / span >
2022-02-20 15:15:38 +01:00
< span class = "na" > target< / span > < span class = "w" > < / span > < span class = "o" > =< / span > < span class = "w" > < / span > < span class = "s" > ghpages://your-user/your-repository?cname=www.example.com< / span > < span class = "w" > < / span >
< / pre > < / div >
< p > Note that this will overwrite whatever custom domain you may have set on
GitHub with every deployment.< / p >
< p > For more information about how CNAMEs work with GitHub you can read about
the feature in the GitHub help center:
< a href = "https://help.github.com/articles/adding-a-cname-file-to-your-repository/" class = "ext" > Adding a CNAME file to your repository< / a > .< / p >
< h2 id = "404-pages" > 404 Pages< / h2 > < p > Per convention the file named < code > 404.html< / code > is used as placeholder if a page
cannot be found. You can create such a page by creating a < code > 404.html/contents.lr< / code >
file.< / p >
< h2 id = "automatic-deployments" > Automatic Deployments< / h2 > < p > If you want to use ghpages it's desirable to have this build automatically.
This is easy to accomplish with the help of Travis-CI. For more information
see < a href = "../travisci/" class = "ref" > Deploying with Travis-CI< / a > .< / p >
< div class = "comment-box" >
< h2 > Comments< / h2 >
< div id = "disqus_thread" > < / div >
< script >
var disqus_config = function() { this.page.identifier = "/docs/deployment/ghpages"; this.page.url = "https://www.getlektor.com/docs/deployment/ghpages/"; };
(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/deployment/ghpages/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 >
