Compare commits
No commits in common. 'master' and 'gh-pages' have entirely different histories.
65 changed files with 12264 additions and 709 deletions
@ -1,3 +0,0 @@
@@ -1,3 +0,0 @@
|
||||
[submodule "mkdocs-material"] |
||||
path = mkdocs-material |
||||
url = https://git.charlesreid1.com/charlesreid1/mkdocs-material |
||||
@ -0,0 +1,644 @@
@@ -0,0 +1,644 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html> |
||||
<html lang="en" class="no-js"> |
||||
<head> |
||||
|
||||
<meta charset="utf-8"> |
||||
<meta name="viewport" content="width=device-width,initial-scale=1"> |
||||
<meta http-equiv="x-ua-compatible" content="ie=edge"> |
||||
|
||||
|
||||
<link rel="canonical" href="https://pages.charlesreid1.com/how-do-i-pelican/Adding/"> |
||||
|
||||
|
||||
|
||||
<meta name="lang:clipboard.copy" content="Copy to clipboard"> |
||||
|
||||
<meta name="lang:clipboard.copied" content="Copied to clipboard"> |
||||
|
||||
<meta name="lang:search.language" content="en"> |
||||
|
||||
<meta name="lang:search.pipeline.stopwords" content="True"> |
||||
|
||||
<meta name="lang:search.pipeline.trimmer" content="True"> |
||||
|
||||
<meta name="lang:search.result.none" content="No matching documents"> |
||||
|
||||
<meta name="lang:search.result.one" content="1 matching document"> |
||||
|
||||
<meta name="lang:search.result.other" content="# matching documents"> |
||||
|
||||
<meta name="lang:search.tokenizer" content="[\s\-]+"> |
||||
|
||||
<link rel="shortcut icon" href=".."> |
||||
<meta name="generator" content="mkdocs-1.0, mkdocs-material-3.0.3"> |
||||
|
||||
|
||||
|
||||
<title>Adding Content - how do I pelican?</title> |
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application.451f80e5.css"> |
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application-palette.22915126.css"> |
||||
|
||||
|
||||
|
||||
|
||||
<meta name="theme-color" content="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<script src="../assets/javascripts/modernizr.1aa3b519.js"></script> |
||||
|
||||
|
||||
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> |
||||
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT Mono","Courier New",Courier,monospace}</style> |
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/fonts/material-icons.css"> |
||||
|
||||
<link rel="stylesheet" href="../css/custom.css"> |
||||
|
||||
|
||||
</head> |
||||
|
||||
|
||||
|
||||
<body dir="ltr" data-md-color-primary="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</defs> |
||||
</svg> |
||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
||||
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label> |
||||
|
||||
<a href="../#adding-content-to-your-site" tabindex="1" class="md-skip"> |
||||
Skip to content |
||||
</a> |
||||
|
||||
|
||||
<header class="md-header" data-md-component="header"> |
||||
<nav class="md-header-nav md-grid"> |
||||
<div class="md-flex"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch"> |
||||
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> |
||||
|
||||
|
||||
<span class="md-header-nav__topic"> |
||||
how do I pelican? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Adding Content |
||||
</span> |
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
|
||||
|
||||
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> |
||||
|
||||
<div class="md-search" data-md-component="search" role="dialog"> |
||||
<label class="md-search__overlay" for="__search"></label> |
||||
<div class="md-search__inner" role="search"> |
||||
<form class="md-search__form" name="search"> |
||||
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> |
||||
<label class="md-icon md-search__icon" for="__search"></label> |
||||
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> |
||||
 |
||||
</button> |
||||
</form> |
||||
<div class="md-search__output"> |
||||
<div class="md-search__scrollwrap" data-md-scrollfix> |
||||
<div class="md-search-result" data-md-component="result"> |
||||
<div class="md-search-result__meta"> |
||||
Type to start searching |
||||
</div> |
||||
<ol class="md-search-result__list"></ol> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
</div> |
||||
|
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<div class="md-header-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
</div> |
||||
|
||||
</div> |
||||
</nav> |
||||
</header> |
||||
|
||||
<div class="md-container"> |
||||
|
||||
|
||||
|
||||
<main class="md-main"> |
||||
<div class="md-main__inner md-grid" data-md-component="container"> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
<nav class="md-nav md-nav--primary" data-md-level="0"> |
||||
<label class="md-nav__title md-nav__title--site" for="__drawer"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pelican? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href=".." title="Index" class="md-nav__link"> |
||||
Index |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Before/" title="Before You Start" class="md-nav__link"> |
||||
Before You Start |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Getting/" title="Getting Started with Pelican" class="md-nav__link"> |
||||
Getting Started with Pelican |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Configuring/" title="Configuring Your Pelican Site" class="md-nav__link"> |
||||
Configuring Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Theming/" title="Theming Your Pelican Site" class="md-nav__link"> |
||||
Theming Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Generating/" title="Generating Your Pelican Site" class="md-nav__link"> |
||||
Generating Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Serving/" title="Serving Your Static Site" class="md-nav__link"> |
||||
Serving Your Static Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc"> |
||||
Adding Content |
||||
</label> |
||||
|
||||
<a href="./" title="Adding Content" class="md-nav__link md-nav__link--active"> |
||||
Adding Content |
||||
</a> |
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#adding-blog-posts-to-your-site" title="Adding blog posts to your site" class="md-nav__link"> |
||||
Adding blog posts to your site |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#adding-pages-to-your-site" title="Adding pages to your site" class="md-nav__link"> |
||||
Adding pages to your site |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#linking-to-other-pages" title="Linking to other pages" class="md-nav__link"> |
||||
Linking to other pages |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#linking-to-static-files" title="Linking to static files" class="md-nav__link"> |
||||
Linking to static files |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Hosting/" title="Hosting on Github Pages" class="md-nav__link"> |
||||
Hosting on Github Pages |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
</ul> |
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#adding-blog-posts-to-your-site" title="Adding blog posts to your site" class="md-nav__link"> |
||||
Adding blog posts to your site |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#adding-pages-to-your-site" title="Adding pages to your site" class="md-nav__link"> |
||||
Adding pages to your site |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#linking-to-other-pages" title="Linking to other pages" class="md-nav__link"> |
||||
Linking to other pages |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#linking-to-static-files" title="Linking to static files" class="md-nav__link"> |
||||
Linking to static files |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1 id="adding-content-to-your-site">Adding content to your site<a class="headerlink" href="#adding-content-to-your-site" title="Permanent link">¶</a></h1> |
||||
<p>Now that you have generated your site with the |
||||
<code>pelican</code> command, and have used Python to serve |
||||
your documentation with a simple HTTP server, |
||||
you have all the tools you need to start creating |
||||
content for your website.</p> |
||||
<p>Also see <a href="http://docs.getpelican.com/en/stable/content.html">writing content</a> |
||||
page of pelican documentation.</p> |
||||
<p>Pelican has two types of content: pages (unchanging, no chronology) |
||||
and articles (blog posts). We will cover each below.</p> |
||||
<h2 id="adding-blog-posts-to-your-site">Adding blog posts to your site<a class="headerlink" href="#adding-blog-posts-to-your-site" title="Permanent link">¶</a></h2> |
||||
<p>Let's cover how you add new content to your site.</p> |
||||
<p>By default, Pelican is set up to create blog sites, |
||||
so we'll cover how to create a blog. Creating static |
||||
sites requires custom themes, and we won't get into that |
||||
in this document.</p> |
||||
<p>In the <code>content/</code> directory (or <code>content/posts/</code> directory), |
||||
you create blog posts by adding Markdown files, and specify |
||||
metadata using a YAML header.</p> |
||||
<p>Here's a Markdown template for a blog post:</p> |
||||
<div class="codehilite"><pre><span></span>Title: My super title |
||||
Date: 2010-12-03 10:20 |
||||
Modified: 2010-12-05 19:30 |
||||
Category: Python |
||||
Tags: pelican, publishing |
||||
Slug: my-super-post |
||||
Authors: Alexis Metaireau, Conan Doyle |
||||
Summary: Short version for index and feeds |
||||
|
||||
This is the content of my super blog post. |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Note that not everything is necessary (e.g., Slug, Authors, Summary). |
||||
Ultimately the variables in the YAML headers of each |
||||
blog post are passed to the theme's page templates, |
||||
so what information gets used depends on the theme |
||||
that you use.</p> |
||||
<h2 id="adding-pages-to-your-site">Adding pages to your site<a class="headerlink" href="#adding-pages-to-your-site" title="Permanent link">¶</a></h2> |
||||
<p>Metadata for </p> |
||||
<h2 id="linking-to-other-pages">Linking to other pages<a class="headerlink" href="#linking-to-other-pages" title="Permanent link">¶</a></h2> |
||||
<p>As shown in the <a href="http://docs.getpelican.com/en/stable/content.html#linking-to-internal-content">linking to internal content</a> |
||||
section of the pelican docs, you can link to other files</p> |
||||
<p><strong><code>article1.md</code>:</strong></p> |
||||
<div class="codehilite"><pre><span></span>Title: The first article |
||||
Date: 2012-12-01 10:02 |
||||
|
||||
See below intra-site link examples in Markdown format. |
||||
|
||||
[a link to another file]({filename}/article2.md) |
||||
</pre></div> |
||||
|
||||
|
||||
<p><strong><code>article2.md</code>:</strong></p> |
||||
<div class="codehilite"><pre><span></span>Title: The second article |
||||
Date: 2012-12-01 10:02 |
||||
|
||||
More markdown goes _here_. |
||||
|
||||
[link back to article one]({filename}/article1.md) |
||||
</pre></div> |
||||
|
||||
|
||||
<p>See <a href="http://docs.getpelican.com/en/stable/content.html#linking-to-internal-content">docs</a> for details.</p> |
||||
<h2 id="linking-to-static-files">Linking to static files<a class="headerlink" href="#linking-to-static-files" title="Permanent link">¶</a></h2> |
||||
<p>For example, a project’s content directory might be structured like this:</p> |
||||
<p>Suppose you have a directory structure like this:</p> |
||||
<div class="codehilite"><pre><span></span>content |
||||
├── images |
||||
│ └── han.jpg |
||||
├── pdfs |
||||
│ └── menu.pdf |
||||
└── pages |
||||
└── test.md |
||||
</pre></div> |
||||
|
||||
|
||||
<p>then in <code>test.md</code> you would link to other files like this:</p> |
||||
<div class="codehilite"><pre><span></span> |
||||
[Our Menu]({filename}/pdfs/menu.pdf) |
||||
</pre></div> |
||||
|
||||
|
||||
<p>See <a href="http://docs.getpelican.com/en/stable/content.html#linking-to-internal-content">docs</a> |
||||
for details...</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
<a href="../Serving/" title="Serving Your Static Site" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Previous |
||||
</span> |
||||
Serving Your Static Site |
||||
</span> |
||||
</div> |
||||
</a> |
||||
|
||||
|
||||
<a href="../Hosting/" title="Hosting on Github Pages" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Next |
||||
</span> |
||||
Hosting on Github Pages |
||||
</span> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
||||
</div> |
||||
</a> |
||||
|
||||
</nav> |
||||
</div> |
||||
|
||||
<div class="md-footer-meta md-typeset"> |
||||
<div class="md-footer-meta__inner md-grid"> |
||||
<div class="md-footer-copyright"> |
||||
|
||||
<div class="md-footer-copyright__highlight"> |
||||
Copyright © 2018 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT license</a> |
||||
</div> |
||||
|
||||
powered by |
||||
<a href="https://www.mkdocs.org">MkDocs</a> |
||||
and |
||||
<a href="https://squidfunk.github.io/mkdocs-material/"> |
||||
Material for MkDocs</a> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
</footer> |
||||
|
||||
</div> |
||||
|
||||
<script src="../assets/javascripts/application.e72fd936.js"></script> |
||||
|
||||
<script>app.initialize({version:"1.0",url:{base:".."}})</script> |
||||
|
||||
<script src="../search/main.js"></script> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
@ -0,0 +1,524 @@
@@ -0,0 +1,524 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html> |
||||
<html lang="en" class="no-js"> |
||||
<head> |
||||
|
||||
<meta charset="utf-8"> |
||||
<meta name="viewport" content="width=device-width,initial-scale=1"> |
||||
<meta http-equiv="x-ua-compatible" content="ie=edge"> |
||||
|
||||
|
||||
<link rel="canonical" href="https://pages.charlesreid1.com/how-do-i-pelican/Before/"> |
||||
|
||||
|
||||
|
||||
<meta name="lang:clipboard.copy" content="Copy to clipboard"> |
||||
|
||||
<meta name="lang:clipboard.copied" content="Copied to clipboard"> |
||||
|
||||
<meta name="lang:search.language" content="en"> |
||||
|
||||
<meta name="lang:search.pipeline.stopwords" content="True"> |
||||
|
||||
<meta name="lang:search.pipeline.trimmer" content="True"> |
||||
|
||||
<meta name="lang:search.result.none" content="No matching documents"> |
||||
|
||||
<meta name="lang:search.result.one" content="1 matching document"> |
||||
|
||||
<meta name="lang:search.result.other" content="# matching documents"> |
||||
|
||||
<meta name="lang:search.tokenizer" content="[\s\-]+"> |
||||
|
||||
<link rel="shortcut icon" href=".."> |
||||
<meta name="generator" content="mkdocs-1.0, mkdocs-material-3.0.3"> |
||||
|
||||
|
||||
|
||||
<title>Before You Start - how do I pelican?</title> |
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application.451f80e5.css"> |
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application-palette.22915126.css"> |
||||
|
||||
|
||||
|
||||
|
||||
<meta name="theme-color" content="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<script src="../assets/javascripts/modernizr.1aa3b519.js"></script> |
||||
|
||||
|
||||
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> |
||||
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT Mono","Courier New",Courier,monospace}</style> |
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/fonts/material-icons.css"> |
||||
|
||||
<link rel="stylesheet" href="../css/custom.css"> |
||||
|
||||
|
||||
</head> |
||||
|
||||
|
||||
|
||||
<body dir="ltr" data-md-color-primary="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</defs> |
||||
</svg> |
||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
||||
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label> |
||||
|
||||
<a href="../#before-you-start" tabindex="1" class="md-skip"> |
||||
Skip to content |
||||
</a> |
||||
|
||||
|
||||
<header class="md-header" data-md-component="header"> |
||||
<nav class="md-header-nav md-grid"> |
||||
<div class="md-flex"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch"> |
||||
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> |
||||
|
||||
|
||||
<span class="md-header-nav__topic"> |
||||
how do I pelican? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Before You Start |
||||
</span> |
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
|
||||
|
||||
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> |
||||
|
||||
<div class="md-search" data-md-component="search" role="dialog"> |
||||
<label class="md-search__overlay" for="__search"></label> |
||||
<div class="md-search__inner" role="search"> |
||||
<form class="md-search__form" name="search"> |
||||
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> |
||||
<label class="md-icon md-search__icon" for="__search"></label> |
||||
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> |
||||
 |
||||
</button> |
||||
</form> |
||||
<div class="md-search__output"> |
||||
<div class="md-search__scrollwrap" data-md-scrollfix> |
||||
<div class="md-search-result" data-md-component="result"> |
||||
<div class="md-search-result__meta"> |
||||
Type to start searching |
||||
</div> |
||||
<ol class="md-search-result__list"></ol> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
</div> |
||||
|
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<div class="md-header-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
</div> |
||||
|
||||
</div> |
||||
</nav> |
||||
</header> |
||||
|
||||
<div class="md-container"> |
||||
|
||||
|
||||
|
||||
<main class="md-main"> |
||||
<div class="md-main__inner md-grid" data-md-component="container"> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
<nav class="md-nav md-nav--primary" data-md-level="0"> |
||||
<label class="md-nav__title md-nav__title--site" for="__drawer"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pelican? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href=".." title="Index" class="md-nav__link"> |
||||
Index |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc"> |
||||
Before You Start |
||||
</label> |
||||
|
||||
<a href="./" title="Before You Start" class="md-nav__link md-nav__link--active"> |
||||
Before You Start |
||||
</a> |
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#before-you-start" title="Before You Start" class="md-nav__link"> |
||||
Before You Start |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Getting/" title="Getting Started with Pelican" class="md-nav__link"> |
||||
Getting Started with Pelican |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Configuring/" title="Configuring Your Pelican Site" class="md-nav__link"> |
||||
Configuring Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Theming/" title="Theming Your Pelican Site" class="md-nav__link"> |
||||
Theming Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Generating/" title="Generating Your Pelican Site" class="md-nav__link"> |
||||
Generating Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Serving/" title="Serving Your Static Site" class="md-nav__link"> |
||||
Serving Your Static Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Adding/" title="Adding Content" class="md-nav__link"> |
||||
Adding Content |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Hosting/" title="Hosting on Github Pages" class="md-nav__link"> |
||||
Hosting on Github Pages |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
</ul> |
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#before-you-start" title="Before You Start" class="md-nav__link"> |
||||
Before You Start |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1>Before You Start</h1> |
||||
|
||||
<h2 id="before-you-start">Before You Start<a class="headerlink" href="#before-you-start" title="Permanent link">¶</a></h2> |
||||
<p>You'll need to have <a href="https://github.com/getpelican/pelican">Pelican</a> installed. |
||||
If you want to use Markdown with Pelican, |
||||
you'll also need to install Markdown.</p> |
||||
<div class="codehilite"><pre><span></span>$ pip install Markdown |
||||
$ pip install pelican |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Also see <a href="http://docs.getpelican.com/en/stable/install.html">installation page</a> |
||||
of Pelican documentation.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
<a href=".." title="Index" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Previous |
||||
</span> |
||||
Index |
||||
</span> |
||||
</div> |
||||
</a> |
||||
|
||||
|
||||
<a href="../Getting/" title="Getting Started with Pelican" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Next |
||||
</span> |
||||
Getting Started with Pelican |
||||
</span> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
||||
</div> |
||||
</a> |
||||
|
||||
</nav> |
||||
</div> |
||||
|
||||
<div class="md-footer-meta md-typeset"> |
||||
<div class="md-footer-meta__inner md-grid"> |
||||
<div class="md-footer-copyright"> |
||||
|
||||
<div class="md-footer-copyright__highlight"> |
||||
Copyright © 2018 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT license</a> |
||||
</div> |
||||
|
||||
powered by |
||||
<a href="https://www.mkdocs.org">MkDocs</a> |
||||
and |
||||
<a href="https://squidfunk.github.io/mkdocs-material/"> |
||||
Material for MkDocs</a> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
</footer> |
||||
|
||||
</div> |
||||
|
||||
<script src="../assets/javascripts/application.e72fd936.js"></script> |
||||
|
||||
<script>app.initialize({version:"1.0",url:{base:".."}})</script> |
||||
|
||||
<script src="../search/main.js"></script> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
@ -0,0 +1,575 @@
@@ -0,0 +1,575 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html> |
||||
<html lang="en" class="no-js"> |
||||
<head> |
||||
|
||||
<meta charset="utf-8"> |
||||
<meta name="viewport" content="width=device-width,initial-scale=1"> |
||||
<meta http-equiv="x-ua-compatible" content="ie=edge"> |
||||
|
||||
|
||||
<link rel="canonical" href="https://pages.charlesreid1.com/how-do-i-pelican/Configuring/"> |
||||
|
||||
|
||||
|
||||
<meta name="lang:clipboard.copy" content="Copy to clipboard"> |
||||
|
||||
<meta name="lang:clipboard.copied" content="Copied to clipboard"> |
||||
|
||||
<meta name="lang:search.language" content="en"> |
||||
|
||||
<meta name="lang:search.pipeline.stopwords" content="True"> |
||||
|
||||
<meta name="lang:search.pipeline.trimmer" content="True"> |
||||
|
||||
<meta name="lang:search.result.none" content="No matching documents"> |
||||
|
||||
<meta name="lang:search.result.one" content="1 matching document"> |
||||
|
||||
<meta name="lang:search.result.other" content="# matching documents"> |
||||
|
||||
<meta name="lang:search.tokenizer" content="[\s\-]+"> |
||||
|
||||
<link rel="shortcut icon" href=".."> |
||||
<meta name="generator" content="mkdocs-1.0, mkdocs-material-3.0.3"> |
||||
|
||||
|
||||
|
||||
<title>Configuring Your Pelican Site - how do I pelican?</title> |
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application.451f80e5.css"> |
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application-palette.22915126.css"> |
||||
|
||||
|
||||
|
||||
|
||||
<meta name="theme-color" content="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<script src="../assets/javascripts/modernizr.1aa3b519.js"></script> |
||||
|
||||
|
||||
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> |
||||
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT Mono","Courier New",Courier,monospace}</style> |
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/fonts/material-icons.css"> |
||||
|
||||
<link rel="stylesheet" href="../css/custom.css"> |
||||
|
||||
|
||||
</head> |
||||
|
||||
|
||||
|
||||
<body dir="ltr" data-md-color-primary="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</defs> |
||||
</svg> |
||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
||||
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label> |
||||
|
||||
<a href="../#configuring-your-pelican-site" tabindex="1" class="md-skip"> |
||||
Skip to content |
||||
</a> |
||||
|
||||
|
||||
<header class="md-header" data-md-component="header"> |
||||
<nav class="md-header-nav md-grid"> |
||||
<div class="md-flex"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch"> |
||||
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> |
||||
|
||||
|
||||
<span class="md-header-nav__topic"> |
||||
how do I pelican? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Configuring Your Pelican Site |
||||
</span> |
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
|
||||
|
||||
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> |
||||
|
||||
<div class="md-search" data-md-component="search" role="dialog"> |
||||
<label class="md-search__overlay" for="__search"></label> |
||||
<div class="md-search__inner" role="search"> |
||||
<form class="md-search__form" name="search"> |
||||
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> |
||||
<label class="md-icon md-search__icon" for="__search"></label> |
||||
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> |
||||
 |
||||
</button> |
||||
</form> |
||||
<div class="md-search__output"> |
||||
<div class="md-search__scrollwrap" data-md-scrollfix> |
||||
<div class="md-search-result" data-md-component="result"> |
||||
<div class="md-search-result__meta"> |
||||
Type to start searching |
||||
</div> |
||||
<ol class="md-search-result__list"></ol> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
</div> |
||||
|
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<div class="md-header-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
</div> |
||||
|
||||
</div> |
||||
</nav> |
||||
</header> |
||||
|
||||
<div class="md-container"> |
||||
|
||||
|
||||
|
||||
<main class="md-main"> |
||||
<div class="md-main__inner md-grid" data-md-component="container"> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
<nav class="md-nav md-nav--primary" data-md-level="0"> |
||||
<label class="md-nav__title md-nav__title--site" for="__drawer"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pelican? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href=".." title="Index" class="md-nav__link"> |
||||
Index |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Before/" title="Before You Start" class="md-nav__link"> |
||||
Before You Start |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Getting/" title="Getting Started with Pelican" class="md-nav__link"> |
||||
Getting Started with Pelican |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc"> |
||||
Configuring Your Pelican Site |
||||
</label> |
||||
|
||||
<a href="./" title="Configuring Your Pelican Site" class="md-nav__link md-nav__link--active"> |
||||
Configuring Your Pelican Site |
||||
</a> |
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#configuring-your-pelican-site" title="Configuring Your Pelican Site" class="md-nav__link"> |
||||
Configuring Your Pelican Site |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Theming/" title="Theming Your Pelican Site" class="md-nav__link"> |
||||
Theming Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Generating/" title="Generating Your Pelican Site" class="md-nav__link"> |
||||
Generating Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Serving/" title="Serving Your Static Site" class="md-nav__link"> |
||||
Serving Your Static Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Adding/" title="Adding Content" class="md-nav__link"> |
||||
Adding Content |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Hosting/" title="Hosting on Github Pages" class="md-nav__link"> |
||||
Hosting on Github Pages |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
</ul> |
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#configuring-your-pelican-site" title="Configuring Your Pelican Site" class="md-nav__link"> |
||||
Configuring Your Pelican Site |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1>Configuring Your Pelican Site</h1> |
||||
|
||||
<h2 id="configuring-your-pelican-site">Configuring Your Pelican Site<a class="headerlink" href="#configuring-your-pelican-site" title="Permanent link">¶</a></h2> |
||||
<p>The <code>pelicanconf.py</code> file contains all configuration variables |
||||
that <a href="https://github.com/getpelican/pelican">Pelican</a> sites need to set.</p> |
||||
<p>Some of the configuration variables are common to all Pelican sites, |
||||
others are particular to the theme you are using.</p> |
||||
<p>Here's an example configuration file from |
||||
<a href="https://github.com/charlesreid1/magic-flying-pelican">magic-flying-pelican</a>:</p> |
||||
<p><strong><code>pelicanconf.py</code>:</strong></p> |
||||
<div class="codehilite"><pre><span></span><span class="n">AUTHOR</span> <span class="o">=</span> <span class="s1">'charlesreid1'</span> |
||||
<span class="n">SITENAME</span> <span class="o">=</span> <span class="s1">'how-do-i-pelican'</span> |
||||
<span class="n">SITEURL</span> <span class="o">=</span> <span class="s1">''</span> |
||||
<span class="n">PATH</span> <span class="o">=</span> <span class="s1">'content'</span> |
||||
<span class="n">TIMEZONE</span> <span class="o">=</span> <span class="s1">'America/Los_Angeles'</span> |
||||
<span class="n">DEFAULT_LANG</span> <span class="o">=</span> <span class="s1">'en'</span> |
||||
|
||||
<span class="c1"># --------------8<---------------------</span> |
||||
<span class="c1"># Theme</span> |
||||
|
||||
<span class="n">THEME</span> <span class="o">=</span> <span class="s1">'simple-bootstrap'</span> |
||||
<span class="c1"># https://github.com/getpelican/pelican-themes/tree/master/simple-bootstrap</span> |
||||
|
||||
|
||||
<span class="c1"># --------------8<---------------------</span> |
||||
<span class="c1"># Files and content</span> |
||||
|
||||
|
||||
<span class="c1"># This will look for a directory img/ </span> |
||||
<span class="c1"># inside the directory content/</span> |
||||
<span class="c1"># The contents of img/ will be available at </span> |
||||
<span class="c1"># {{ SITEURL }}/img</span> |
||||
<span class="n">STATIC_PATHS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'img'</span><span class="p">]</span> |
||||
|
||||
<span class="c1"># If we want to create static pages,</span> |
||||
<span class="c1"># we should put them in content/pages</span> |
||||
<span class="n">PAGE_PATHS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'pages'</span><span class="p">]</span> |
||||
|
||||
<span class="c1"># If we want to create blog posts (articles),</span> |
||||
<span class="c1"># we should put them in content/posts</span> |
||||
<span class="n">ARTICLE_PATHS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'posts'</span><span class="p">]</span> |
||||
|
||||
|
||||
<span class="c1"># --------------8<---------------------</span> |
||||
<span class="c1"># idk just some dumb stuff</span> |
||||
|
||||
<span class="n">DISPLAY_PAGES_ON_MENU</span> <span class="o">=</span> <span class="bp">False</span> |
||||
<span class="n">FEED_ALL_ATOM</span> <span class="o">=</span> <span class="bp">None</span> |
||||
<span class="n">CATEGORY_FEED_ATOM</span> <span class="o">=</span> <span class="bp">None</span> |
||||
<span class="n">TRANSLATION_FEED_ATOM</span> <span class="o">=</span> <span class="bp">None</span> |
||||
<span class="n">AUTHOR_FEED_ATOM</span> <span class="o">=</span> <span class="bp">None</span> |
||||
<span class="n">AUTHOR_FEED_RSS</span> <span class="o">=</span> <span class="bp">None</span> |
||||
<span class="n">DEFAULT_PAGINATION</span> <span class="o">=</span> <span class="bp">False</span> |
||||
</pre></div> |
||||
|
||||
|
||||
<p>This will configure the <code>content/</code> directory |
||||
to contain a <code>posts/</code> folder with blog posts |
||||
and a <code>pages/</code> folder with static pages.</p> |
||||
<p>There's a lot more that can be done with the |
||||
configuration file, but much of it requires |
||||
custom themes, so we'll leave it at that.</p> |
||||
<p>See the <a href="http://docs.getpelican.com/en/stable/settings.html?highlight=configuration">settings page</a> |
||||
of the pelican documentation for details.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
<a href="../Getting/" title="Getting Started with Pelican" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Previous |
||||
</span> |
||||
Getting Started with Pelican |
||||
</span> |
||||
</div> |
||||
</a> |
||||
|
||||
|
||||
<a href="../Theming/" title="Theming Your Pelican Site" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Next |
||||
</span> |
||||
Theming Your Pelican Site |
||||
</span> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
||||
</div> |
||||
</a> |
||||
|
||||
</nav> |
||||
</div> |
||||
|
||||
<div class="md-footer-meta md-typeset"> |
||||
<div class="md-footer-meta__inner md-grid"> |
||||
<div class="md-footer-copyright"> |
||||
|
||||
<div class="md-footer-copyright__highlight"> |
||||
Copyright © 2018 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT license</a> |
||||
</div> |
||||
|
||||
powered by |
||||
<a href="https://www.mkdocs.org">MkDocs</a> |
||||
and |
||||
<a href="https://squidfunk.github.io/mkdocs-material/"> |
||||
Material for MkDocs</a> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
</footer> |
||||
|
||||
</div> |
||||
|
||||
<script src="../assets/javascripts/application.e72fd936.js"></script> |
||||
|
||||
<script>app.initialize({version:"1.0",url:{base:".."}})</script> |
||||
|
||||
<script src="../search/main.js"></script> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
@ -0,0 +1,500 @@
@@ -0,0 +1,500 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html> |
||||
<html lang="en" class="no-js"> |
||||
<head> |
||||
|
||||
<meta charset="utf-8"> |
||||
<meta name="viewport" content="width=device-width,initial-scale=1"> |
||||
<meta http-equiv="x-ua-compatible" content="ie=edge"> |
||||
|
||||
|
||||
<link rel="canonical" href="https://pages.charlesreid1.com/how-do-i-pelican/Generating/"> |
||||
|
||||
|
||||
|
||||
<meta name="lang:clipboard.copy" content="Copy to clipboard"> |
||||
|
||||
<meta name="lang:clipboard.copied" content="Copied to clipboard"> |
||||
|
||||
<meta name="lang:search.language" content="en"> |
||||
|
||||
<meta name="lang:search.pipeline.stopwords" content="True"> |
||||
|
||||
<meta name="lang:search.pipeline.trimmer" content="True"> |
||||
|
||||
<meta name="lang:search.result.none" content="No matching documents"> |
||||
|
||||
<meta name="lang:search.result.one" content="1 matching document"> |
||||
|
||||
<meta name="lang:search.result.other" content="# matching documents"> |
||||
|
||||
<meta name="lang:search.tokenizer" content="[\s\-]+"> |
||||
|
||||
<link rel="shortcut icon" href=".."> |
||||
<meta name="generator" content="mkdocs-1.0, mkdocs-material-3.0.3"> |
||||
|
||||
|
||||
|
||||
<title>Generating Your Pelican Site - how do I pelican?</title> |
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application.451f80e5.css"> |
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application-palette.22915126.css"> |
||||
|
||||
|
||||
|
||||
|
||||
<meta name="theme-color" content="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<script src="../assets/javascripts/modernizr.1aa3b519.js"></script> |
||||
|
||||
|
||||
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> |
||||
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT Mono","Courier New",Courier,monospace}</style> |
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/fonts/material-icons.css"> |
||||
|
||||
<link rel="stylesheet" href="../css/custom.css"> |
||||
|
||||
|
||||
</head> |
||||
|
||||
|
||||
|
||||
<body dir="ltr" data-md-color-primary="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</defs> |
||||
</svg> |
||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
||||
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label> |
||||
|
||||
<a href="../#generating-your-static-site" tabindex="1" class="md-skip"> |
||||
Skip to content |
||||
</a> |
||||
|
||||
|
||||
<header class="md-header" data-md-component="header"> |
||||
<nav class="md-header-nav md-grid"> |
||||
<div class="md-flex"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch"> |
||||
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> |
||||
|
||||
|
||||
<span class="md-header-nav__topic"> |
||||
how do I pelican? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Generating Your Pelican Site |
||||
</span> |
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
|
||||
|
||||
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> |
||||
|
||||
<div class="md-search" data-md-component="search" role="dialog"> |
||||
<label class="md-search__overlay" for="__search"></label> |
||||
<div class="md-search__inner" role="search"> |
||||
<form class="md-search__form" name="search"> |
||||
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> |
||||
<label class="md-icon md-search__icon" for="__search"></label> |
||||
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> |
||||
 |
||||
</button> |
||||
</form> |
||||
<div class="md-search__output"> |
||||
<div class="md-search__scrollwrap" data-md-scrollfix> |
||||
<div class="md-search-result" data-md-component="result"> |
||||
<div class="md-search-result__meta"> |
||||
Type to start searching |
||||
</div> |
||||
<ol class="md-search-result__list"></ol> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
</div> |
||||
|
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<div class="md-header-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
</div> |
||||
|
||||
</div> |
||||
</nav> |
||||
</header> |
||||
|
||||
<div class="md-container"> |
||||
|
||||
|
||||
|
||||
<main class="md-main"> |
||||
<div class="md-main__inner md-grid" data-md-component="container"> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
<nav class="md-nav md-nav--primary" data-md-level="0"> |
||||
<label class="md-nav__title md-nav__title--site" for="__drawer"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pelican? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href=".." title="Index" class="md-nav__link"> |
||||
Index |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Before/" title="Before You Start" class="md-nav__link"> |
||||
Before You Start |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Getting/" title="Getting Started with Pelican" class="md-nav__link"> |
||||
Getting Started with Pelican |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Configuring/" title="Configuring Your Pelican Site" class="md-nav__link"> |
||||
Configuring Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Theming/" title="Theming Your Pelican Site" class="md-nav__link"> |
||||
Theming Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
|
||||
|
||||
<a href="./" title="Generating Your Pelican Site" class="md-nav__link md-nav__link--active"> |
||||
Generating Your Pelican Site |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Serving/" title="Serving Your Static Site" class="md-nav__link"> |
||||
Serving Your Static Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Adding/" title="Adding Content" class="md-nav__link"> |
||||
Adding Content |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Hosting/" title="Hosting on Github Pages" class="md-nav__link"> |
||||
Hosting on Github Pages |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
</ul> |
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1 id="generating-your-static-site">Generating your static site<a class="headerlink" href="#generating-your-static-site" title="Permanent link">¶</a></h1> |
||||
<p>To generate your static site with <a href="https://github.com/getpelican/pelican">Pelican</a>, |
||||
use the <code>pelican content</code> command, run from |
||||
the <code>pelican/</code> directory (see <a href="../Getting/">getting started</a> |
||||
for a guide to the pelican directory layout):</p> |
||||
<div class="codehilite"><pre><span></span>$ pelican |
||||
</pre></div> |
||||
|
||||
|
||||
<p>This will generate the static site content into |
||||
the <code>output/</code> folder.</p> |
||||
<p>Inputs: <code>content/</code></p> |
||||
<p>Output: <code>output/</code></p> |
||||
<p>To modify the input folder, change the <code>PATH</code> variable |
||||
in <code>pelicanconf.py</code>:</p> |
||||
<div class="codehilite"><pre><span></span>PATH = 'my_custom_content_dir' |
||||
</pre></div> |
||||
|
||||
|
||||
<p>To modify the output directory, set the |
||||
<code>OUTPUT_PATH</code> variable in <code>pelicanconf.py</code>:</p> |
||||
<div class="codehilite"><pre><span></span>OUTPUT_PATH = 'my_custom_output_dir' |
||||
</pre></div> |
||||
|
||||
|
||||
<p>See the <a href="http://docs.getpelican.com/en/stable/settings.html">settings page</a> |
||||
of the pelican documentation for more variables |
||||
that can be set in the <code>pelicanconf.py</code> file.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
<a href="../Theming/" title="Theming Your Pelican Site" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Previous |
||||
</span> |
||||
Theming Your Pelican Site |
||||
</span> |
||||
</div> |
||||
</a> |
||||
|
||||
|
||||
<a href="../Serving/" title="Serving Your Static Site" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Next |
||||
</span> |
||||
Serving Your Static Site |
||||
</span> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
||||
</div> |
||||
</a> |
||||
|
||||
</nav> |
||||
</div> |
||||
|
||||
<div class="md-footer-meta md-typeset"> |
||||
<div class="md-footer-meta__inner md-grid"> |
||||
<div class="md-footer-copyright"> |
||||
|
||||
<div class="md-footer-copyright__highlight"> |
||||
Copyright © 2018 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT license</a> |
||||
</div> |
||||
|
||||
powered by |
||||
<a href="https://www.mkdocs.org">MkDocs</a> |
||||
and |
||||
<a href="https://squidfunk.github.io/mkdocs-material/"> |
||||
Material for MkDocs</a> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
</footer> |
||||
|
||||
</div> |
||||
|
||||
<script src="../assets/javascripts/application.e72fd936.js"></script> |
||||
|
||||
<script>app.initialize({version:"1.0",url:{base:".."}})</script> |
||||
|
||||
<script src="../search/main.js"></script> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
@ -0,0 +1,709 @@
@@ -0,0 +1,709 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html> |
||||
<html lang="en" class="no-js"> |
||||
<head> |
||||
|
||||
<meta charset="utf-8"> |
||||
<meta name="viewport" content="width=device-width,initial-scale=1"> |
||||
<meta http-equiv="x-ua-compatible" content="ie=edge"> |
||||
|
||||
|
||||
<link rel="canonical" href="https://pages.charlesreid1.com/how-do-i-pelican/Getting/"> |
||||
|
||||
|
||||
|
||||
<meta name="lang:clipboard.copy" content="Copy to clipboard"> |
||||
|
||||
<meta name="lang:clipboard.copied" content="Copied to clipboard"> |
||||
|
||||
<meta name="lang:search.language" content="en"> |
||||
|
||||
<meta name="lang:search.pipeline.stopwords" content="True"> |
||||
|
||||
<meta name="lang:search.pipeline.trimmer" content="True"> |
||||
|
||||
<meta name="lang:search.result.none" content="No matching documents"> |
||||
|
||||
<meta name="lang:search.result.one" content="1 matching document"> |
||||
|
||||
<meta name="lang:search.result.other" content="# matching documents"> |
||||
|
||||
<meta name="lang:search.tokenizer" content="[\s\-]+"> |
||||
|
||||
<link rel="shortcut icon" href=".."> |
||||
<meta name="generator" content="mkdocs-1.0, mkdocs-material-3.0.3"> |
||||
|
||||
|
||||
|
||||
<title>Getting Started with Pelican - how do I pelican?</title> |
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application.451f80e5.css"> |
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application-palette.22915126.css"> |
||||
|
||||
|
||||
|
||||
|
||||
<meta name="theme-color" content="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<script src="../assets/javascripts/modernizr.1aa3b519.js"></script> |
||||
|
||||
|
||||
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> |
||||
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT Mono","Courier New",Courier,monospace}</style> |
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/fonts/material-icons.css"> |
||||
|
||||
<link rel="stylesheet" href="../css/custom.css"> |
||||
|
||||
|
||||
</head> |
||||
|
||||
|
||||
|
||||
<body dir="ltr" data-md-color-primary="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</defs> |
||||
</svg> |
||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
||||
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label> |
||||
|
||||
<a href="../#getting-started-with-pelican" tabindex="1" class="md-skip"> |
||||
Skip to content |
||||
</a> |
||||
|
||||
|
||||
<header class="md-header" data-md-component="header"> |
||||
<nav class="md-header-nav md-grid"> |
||||
<div class="md-flex"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch"> |
||||
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> |
||||
|
||||
|
||||
<span class="md-header-nav__topic"> |
||||
how do I pelican? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Getting Started with Pelican |
||||
</span> |
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
|
||||
|
||||
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> |
||||
|
||||
<div class="md-search" data-md-component="search" role="dialog"> |
||||
<label class="md-search__overlay" for="__search"></label> |
||||
<div class="md-search__inner" role="search"> |
||||
<form class="md-search__form" name="search"> |
||||
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> |
||||
<label class="md-icon md-search__icon" for="__search"></label> |
||||
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> |
||||
 |
||||
</button> |
||||
</form> |
||||
<div class="md-search__output"> |
||||
<div class="md-search__scrollwrap" data-md-scrollfix> |
||||
<div class="md-search-result" data-md-component="result"> |
||||
<div class="md-search-result__meta"> |
||||
Type to start searching |
||||
</div> |
||||
<ol class="md-search-result__list"></ol> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
</div> |
||||
|
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<div class="md-header-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
</div> |
||||
|
||||
</div> |
||||
</nav> |
||||
</header> |
||||
|
||||
<div class="md-container"> |
||||
|
||||
|
||||
|
||||
<main class="md-main"> |
||||
<div class="md-main__inner md-grid" data-md-component="container"> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
<nav class="md-nav md-nav--primary" data-md-level="0"> |
||||
<label class="md-nav__title md-nav__title--site" for="__drawer"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pelican? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href=".." title="Index" class="md-nav__link"> |
||||
Index |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Before/" title="Before You Start" class="md-nav__link"> |
||||
Before You Start |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc"> |
||||
Getting Started with Pelican |
||||
</label> |
||||
|
||||
<a href="./" title="Getting Started with Pelican" class="md-nav__link md-nav__link--active"> |
||||
Getting Started with Pelican |
||||
</a> |
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#how-pelican-works" title="How Pelican Works" class="md-nav__link"> |
||||
How Pelican Works |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#repository-and-branch-layout" title="Repository and Branch Layout" class="md-nav__link"> |
||||
Repository and Branch Layout |
||||
</a> |
||||
|
||||
<nav class="md-nav"> |
||||
<ul class="md-nav__list"> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#recommended-way-project-page" title="Recommended way: project page" class="md-nav__link"> |
||||
Recommended way: project page |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#uncommon-way-personal-page" title="Uncommon way: personal page" class="md-nav__link"> |
||||
Uncommon way: personal page |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#clean-way-pelican-as-a-separate-branch" title="Clean way: pelican as a separate branch" class="md-nav__link"> |
||||
Clean way: pelican as a separate branch |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
</ul> |
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#directory-layout" title="Directory Layout" class="md-nav__link"> |
||||
Directory Layout |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Configuring/" title="Configuring Your Pelican Site" class="md-nav__link"> |
||||
Configuring Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Theming/" title="Theming Your Pelican Site" class="md-nav__link"> |
||||
Theming Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Generating/" title="Generating Your Pelican Site" class="md-nav__link"> |
||||
Generating Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Serving/" title="Serving Your Static Site" class="md-nav__link"> |
||||
Serving Your Static Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Adding/" title="Adding Content" class="md-nav__link"> |
||||
Adding Content |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Hosting/" title="Hosting on Github Pages" class="md-nav__link"> |
||||
Hosting on Github Pages |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
</ul> |
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#how-pelican-works" title="How Pelican Works" class="md-nav__link"> |
||||
How Pelican Works |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#repository-and-branch-layout" title="Repository and Branch Layout" class="md-nav__link"> |
||||
Repository and Branch Layout |
||||
</a> |
||||
|
||||
<nav class="md-nav"> |
||||
<ul class="md-nav__list"> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#recommended-way-project-page" title="Recommended way: project page" class="md-nav__link"> |
||||
Recommended way: project page |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#uncommon-way-personal-page" title="Uncommon way: personal page" class="md-nav__link"> |
||||
Uncommon way: personal page |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#clean-way-pelican-as-a-separate-branch" title="Clean way: pelican as a separate branch" class="md-nav__link"> |
||||
Clean way: pelican as a separate branch |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
</ul> |
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#directory-layout" title="Directory Layout" class="md-nav__link"> |
||||
Directory Layout |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1 id="getting-started-with-pelican">Getting Started with Pelican<a class="headerlink" href="#getting-started-with-pelican" title="Permanent link">¶</a></h1> |
||||
<p>There are a few things you'll need to get started with <a href="https://github.com/getpelican/pelican">Pelican</a>:</p> |
||||
<ul> |
||||
<li>(required) <code>pelicanconf.py</code> - pelican configuration file</li> |
||||
<li>(required) <code>content/</code> - directory containing materials to render into a static site</li> |
||||
<li>(optional) theme - either a local directory containing a theme, or a system-wide pelican theme</li> |
||||
</ul> |
||||
<p>Use the <a href="https://github.com/charlesreid1/magic-flying-pelican">magic-flying-pelican</a> |
||||
repository as a seed repo for getting started with Pelican.</p> |
||||
<p>Basically, copy the contents of the <code>pelican/</code> directory |
||||
in <a href="https://github.com/charlesreid1/magic-flying-pelican">magic-flying-pelican</a> |
||||
into your own repository, and modify the contents for |
||||
your own static site.</p> |
||||
<p>We'll walk through what the <code>pelican/</code> directory contains and what you |
||||
need to change to get a simple static site up and running. </p> |
||||
<h2 id="how-pelican-works">How Pelican Works<a class="headerlink" href="#how-pelican-works" title="Permanent link">¶</a></h2> |
||||
<p>Let's cover the 101 of how Pelican works.</p> |
||||
<p>Pelican takes a pile of HTML, markdown, and other files, |
||||
and compiles them into a static site. (The advantage of |
||||
using a static site instead of a dynamic server like |
||||
Flask or a dynamic language like PHP is speed.)</p> |
||||
<p>To do that, it reads configuration settings from |
||||
<code>pelicanconf.py</code>, which tell Pelican where to look |
||||
for the raw files, as well as other settings like |
||||
the theme to use.</p> |
||||
<p>The default location of content is the <code>content/</code> |
||||
directory, but more can be added.</p> |
||||
<p>The default behavior for Pelican is to serve a blog |
||||
with a few static pages, but users can define themes |
||||
that are static pages only (no blog component).</p> |
||||
<p>The themes work by providing a set of static files |
||||
and a set of HTML Jinja templates. Pelican uses |
||||
the static content and the theme to render the |
||||
final page.</p> |
||||
<p>See <a href="https://github.com/getpelican/pelican-themes">pelican-themes</a> |
||||
repository for themes.</p> |
||||
<p>See <a href="http://www.pelicanthemes.com/">live gallery</a> |
||||
of pelican themes.</p> |
||||
<h2 id="repository-and-branch-layout">Repository and Branch Layout<a class="headerlink" href="#repository-and-branch-layout" title="Permanent link">¶</a></h2> |
||||
<p>When using Pelican to create a static site on Github Pages, |
||||
you will need to organize your repository and set up |
||||
branches as follows.</p> |
||||
<h3 id="recommended-way-project-page">Recommended way: project page<a class="headerlink" href="#recommended-way-project-page" title="Permanent link">¶</a></h3> |
||||
<p>If you are hosting a project Github Pages site |
||||
(that is, a Github Pages page for any arbitrary |
||||
Github project), you should organize your repo |
||||
as follows:</p> |
||||
<ul> |
||||
<li><code>gh-pages</code> branch contains all static content</li> |
||||
<li><code>master</code> branch contains the pelican site</li> |
||||
</ul> |
||||
<h3 id="uncommon-way-personal-page">Uncommon way: personal page<a class="headerlink" href="#uncommon-way-personal-page" title="Permanent link">¶</a></h3> |
||||
<p>If you are hosting a personal Github Pages site |
||||
(a repository under the account <code>@yourusername</code> |
||||
called <code>yourusername.github.io</code>), this should be |
||||
organized as follows:</p> |
||||
<ul> |
||||
<li><code>master</code> branch contains all static content</li> |
||||
<li><code>source</code> branch contains the <code>pelican/</code> directory</li> |
||||
</ul> |
||||
<h3 id="clean-way-pelican-as-a-separate-branch">Clean way: pelican as a separate branch<a class="headerlink" href="#clean-way-pelican-as-a-separate-branch" title="Permanent link">¶</a></h3> |
||||
<p>If you have a large project or you really don't want |
||||
to clutter your repository branch with Pelican files, |
||||
you can also set up a three-branch model as follows:</p> |
||||
<ul> |
||||
<li><code>master</code> branch contains the source code for your project (no Pelican files)</li> |
||||
<li><code>source</code> branch contains the Pelican files for your site</li> |
||||
<li><code>gh-pages</code> contains all static content for the Github Pages page</li> |
||||
</ul> |
||||
<h2 id="directory-layout">Directory Layout<a class="headerlink" href="#directory-layout" title="Permanent link">¶</a></h2> |
||||
<p>While Pelican is flexible enough to handle many |
||||
directory layouts, let's cover a common pattern: |
||||
putting markdown files into <code>content/</code>.</p> |
||||
<div class="codehilite"><pre><span></span>my-cool-project/ |
||||
|
||||
pelican/ |
||||
|
||||
pelicanconf.py |
||||
|
||||
output/ |
||||
index.html |
||||
... |
||||
|
||||
content/ |
||||
posts/ |
||||
blog-post-1.md |
||||
blog-post-2.md |
||||
blog-post-3.md |
||||
pages/ |
||||
faq.md |
||||
about.md |
||||
contact.md |
||||
img/ |
||||
my-image-1.jpg |
||||
my-image-2.jpg |
||||
my-image-3.jpg |
||||
</pre></div> |
||||
|
||||
|
||||
<p>The pelican directory contains a configuration |
||||
file <code>pelicanconf.py</code>, a folder with content |
||||
<code>content/</code>, and an output directory <code>output/</code> |
||||
where the final static files for the site go. |
||||
(See <a href="../Configuring/">configuring</a>).</p> |
||||
<p>The <code>output/</code> directory will not be present |
||||
until you generate site content (see <a href="../Generating/">generating</a>).</p> |
||||
<p>The <code>output/</code> directory should be ignored by git. |
||||
In a later section of this document we will cover |
||||
a pattern for linking output to a Github Pages |
||||
site (see <a href="#">workflow: update</a> WorkflowUpdate.md).</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
<a href="../Before/" title="Before You Start" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Previous |
||||
</span> |
||||
Before You Start |
||||
</span> |
||||
</div> |
||||
</a> |
||||
|
||||
|
||||
<a href="../Configuring/" title="Configuring Your Pelican Site" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Next |
||||
</span> |
||||
Configuring Your Pelican Site |
||||
</span> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
||||
</div> |
||||
</a> |
||||
|
||||
</nav> |
||||
</div> |
||||
|
||||
<div class="md-footer-meta md-typeset"> |
||||
<div class="md-footer-meta__inner md-grid"> |
||||
<div class="md-footer-copyright"> |
||||
|
||||
<div class="md-footer-copyright__highlight"> |
||||
Copyright © 2018 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT license</a> |
||||
</div> |
||||
|
||||
powered by |
||||
<a href="https://www.mkdocs.org">MkDocs</a> |
||||
and |
||||
<a href="https://squidfunk.github.io/mkdocs-material/"> |
||||
Material for MkDocs</a> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
</footer> |
||||
|
||||
</div> |
||||
|
||||
<script src="../assets/javascripts/application.e72fd936.js"></script> |
||||
|
||||
<script>app.initialize({version:"1.0",url:{base:".."}})</script> |
||||
|
||||
<script src="../search/main.js"></script> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
@ -0,0 +1,691 @@
@@ -0,0 +1,691 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html> |
||||
<html lang="en" class="no-js"> |
||||
<head> |
||||
|
||||
<meta charset="utf-8"> |
||||
<meta name="viewport" content="width=device-width,initial-scale=1"> |
||||
<meta http-equiv="x-ua-compatible" content="ie=edge"> |
||||
|
||||
|
||||
<link rel="canonical" href="https://pages.charlesreid1.com/how-do-i-pelican/Hosting/"> |
||||
|
||||
|
||||
|
||||
<meta name="lang:clipboard.copy" content="Copy to clipboard"> |
||||
|
||||
<meta name="lang:clipboard.copied" content="Copied to clipboard"> |
||||
|
||||
<meta name="lang:search.language" content="en"> |
||||
|
||||
<meta name="lang:search.pipeline.stopwords" content="True"> |
||||
|
||||
<meta name="lang:search.pipeline.trimmer" content="True"> |
||||
|
||||
<meta name="lang:search.result.none" content="No matching documents"> |
||||
|
||||
<meta name="lang:search.result.one" content="1 matching document"> |
||||
|
||||
<meta name="lang:search.result.other" content="# matching documents"> |
||||
|
||||
<meta name="lang:search.tokenizer" content="[\s\-]+"> |
||||
|
||||
<link rel="shortcut icon" href=".."> |
||||
<meta name="generator" content="mkdocs-1.0, mkdocs-material-3.0.3"> |
||||
|
||||
|
||||
|
||||
<title>Hosting on Github Pages - how do I pelican?</title> |
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application.451f80e5.css"> |
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application-palette.22915126.css"> |
||||
|
||||
|
||||
|
||||
|
||||
<meta name="theme-color" content="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<script src="../assets/javascripts/modernizr.1aa3b519.js"></script> |
||||
|
||||
|
||||
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> |
||||
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT Mono","Courier New",Courier,monospace}</style> |
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/fonts/material-icons.css"> |
||||
|
||||
<link rel="stylesheet" href="../css/custom.css"> |
||||
|
||||
|
||||
</head> |
||||
|
||||
|
||||
|
||||
<body dir="ltr" data-md-color-primary="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</defs> |
||||
</svg> |
||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
||||
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label> |
||||
|
||||
<a href="../#hosting-on-github-pages" tabindex="1" class="md-skip"> |
||||
Skip to content |
||||
</a> |
||||
|
||||
|
||||
<header class="md-header" data-md-component="header"> |
||||
<nav class="md-header-nav md-grid"> |
||||
<div class="md-flex"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch"> |
||||
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> |
||||
|
||||
|
||||
<span class="md-header-nav__topic"> |
||||
how do I pelican? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Hosting on Github Pages |
||||
</span> |
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
|
||||
|
||||
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> |
||||
|
||||
<div class="md-search" data-md-component="search" role="dialog"> |
||||
<label class="md-search__overlay" for="__search"></label> |
||||
<div class="md-search__inner" role="search"> |
||||
<form class="md-search__form" name="search"> |
||||
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> |
||||
<label class="md-icon md-search__icon" for="__search"></label> |
||||
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> |
||||
 |
||||
</button> |
||||
</form> |
||||
<div class="md-search__output"> |
||||
<div class="md-search__scrollwrap" data-md-scrollfix> |
||||
<div class="md-search-result" data-md-component="result"> |
||||
<div class="md-search-result__meta"> |
||||
Type to start searching |
||||
</div> |
||||
<ol class="md-search-result__list"></ol> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
</div> |
||||
|
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<div class="md-header-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
</div> |
||||
|
||||
</div> |
||||
</nav> |
||||
</header> |
||||
|
||||
<div class="md-container"> |
||||
|
||||
|
||||
|
||||
<main class="md-main"> |
||||
<div class="md-main__inner md-grid" data-md-component="container"> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
<nav class="md-nav md-nav--primary" data-md-level="0"> |
||||
<label class="md-nav__title md-nav__title--site" for="__drawer"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pelican? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href=".." title="Index" class="md-nav__link"> |
||||
Index |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Before/" title="Before You Start" class="md-nav__link"> |
||||
Before You Start |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Getting/" title="Getting Started with Pelican" class="md-nav__link"> |
||||
Getting Started with Pelican |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Configuring/" title="Configuring Your Pelican Site" class="md-nav__link"> |
||||
Configuring Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Theming/" title="Theming Your Pelican Site" class="md-nav__link"> |
||||
Theming Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Generating/" title="Generating Your Pelican Site" class="md-nav__link"> |
||||
Generating Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Serving/" title="Serving Your Static Site" class="md-nav__link"> |
||||
Serving Your Static Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Adding/" title="Adding Content" class="md-nav__link"> |
||||
Adding Content |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc"> |
||||
Hosting on Github Pages |
||||
</label> |
||||
|
||||
<a href="./" title="Hosting on Github Pages" class="md-nav__link md-nav__link--active"> |
||||
Hosting on Github Pages |
||||
</a> |
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#differences-between-personal-and-project-pages" title="Differences between personal and project pages" class="md-nav__link"> |
||||
Differences between personal and project pages |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#where-is-it" title="Where is it?" class="md-nav__link"> |
||||
Where is it? |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#initializing-gh-pages-branch" title="Initializing gh-pages branch" class="md-nav__link"> |
||||
Initializing gh-pages branch |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#enabling-github-pages" title="Enabling Github Pages" class="md-nav__link"> |
||||
Enabling Github Pages |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#adding-the-real-content" title="Adding the real content" class="md-nav__link"> |
||||
Adding the real content |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
</ul> |
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#differences-between-personal-and-project-pages" title="Differences between personal and project pages" class="md-nav__link"> |
||||
Differences between personal and project pages |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#where-is-it" title="Where is it?" class="md-nav__link"> |
||||
Where is it? |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#initializing-gh-pages-branch" title="Initializing gh-pages branch" class="md-nav__link"> |
||||
Initializing gh-pages branch |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#enabling-github-pages" title="Enabling Github Pages" class="md-nav__link"> |
||||
Enabling Github Pages |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#adding-the-real-content" title="Adding the real content" class="md-nav__link"> |
||||
Adding the real content |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1 id="hosting-on-github-pages">Hosting on Github Pages<a class="headerlink" href="#hosting-on-github-pages" title="Permanent link">¶</a></h1> |
||||
<p>Now that you've configured your <a href="https://github.com/getpelican/pelican">Pelican</a> site, |
||||
created your content, viewed it, modified it, |
||||
and are happy with it, you're ready to deploy |
||||
your site somewhere viewable by the public.</p> |
||||
<p>Enter Github Pages.</p> |
||||
<p>Github provides free web hosting for static content |
||||
for <em>every single repository on Github</em>. |
||||
That means you can deploy your static site |
||||
to Github Pages for no-hassle serverless |
||||
web hosting.</p> |
||||
<p>(Also see the <a href="http://docs.getpelican.com/en/stable/publish.html">publish</a> |
||||
page of the pelican documentation.)</p> |
||||
<h2 id="differences-between-personal-and-project-pages">Differences between personal and project pages<a class="headerlink" href="#differences-between-personal-and-project-pages" title="Permanent link">¶</a></h2> |
||||
<p>In this walkthrough we assume the most common scenario |
||||
of deploying a page on Github Pages for a project.</p> |
||||
<p>Setting up a personal page requires changing |
||||
branch names - see <a href="../Getting/">getting started</a> |
||||
and the section on branches in particular. |
||||
Change <code>gh-pages</code> to <code>master</code> and <code>master</code> to <code>source</code>.</p> |
||||
<p>The rest of the document will assume you are creating |
||||
a project page.</p> |
||||
<h2 id="where-is-it">Where is it?<a class="headerlink" href="#where-is-it" title="Permanent link">¶</a></h2> |
||||
<p>Where do Github Pages live?</p> |
||||
<p>If your username is <code>username</code> and your project name is <code>projectname</code>, |
||||
the Github source code is at:</p> |
||||
<div class="codehilite"><pre><span></span>https://github.com/username/projectname |
||||
</pre></div> |
||||
|
||||
|
||||
<p>and the Github Pages page will be at:</p> |
||||
<div class="codehilite"><pre><span></span>https://username.github.io/projectname |
||||
</pre></div> |
||||
|
||||
|
||||
<h2 id="initializing-gh-pages-branch">Initializing gh-pages branch<a class="headerlink" href="#initializing-gh-pages-branch" title="Permanent link">¶</a></h2> |
||||
<p>Before you begin, you have to create a <code>gh-pages</code> branch. |
||||
We want to create a new branch that is <em>completely independent</em> |
||||
of all other branches, because this branch will only contain |
||||
the static content of our website - no code, no readmes, |
||||
nothing but HTML, CSS, and Javascript.</p> |
||||
<p>We want to link the <code>gh-pages</code> branch, which will contain |
||||
the site's static content, with the <code>output/</code> directory, |
||||
where Pelican generates all of its static content.</p> |
||||
<p>Remove the output directory, and clone a copy of |
||||
your repo to the output directory:</p> |
||||
<div class="codehilite"><pre><span></span>$ cd pelican/ |
||||
$ rm -rf output/ |
||||
$ git clone https://github.com/username/projectname.git output |
||||
$ cd output/ |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Now create a new orphan branch - that's the git terminology |
||||
for a branch that shares no history with any other branches. |
||||
Call it <code>gh-pages</code>:</p> |
||||
<div class="codehilite"><pre><span></span>$ git checkout --orphan gh-pages |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Now all the content that was in the master branch |
||||
will show up as untracked files, because the new |
||||
<code>gh-pages</code> branch is totally empty.</p> |
||||
<p>Remove everything in the directory except |
||||
the <code>.git</code> directory:</p> |
||||
<div class="codehilite"><pre><span></span>$ rm -rf * |
||||
$ rm -rf .gitignore .gitmodules |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Now add a simple "Hello world" page that we'll use |
||||
to make sure our Github Pages page is being |
||||
hosted correctly:</p> |
||||
<div class="codehilite"><pre><span></span>$ echo '<h2>Hello world!</h2>' > index.html |
||||
$ git add index.html |
||||
$ git commit index.html -m 'Initial commit of gh-pages branch' |
||||
$ git push origin gh-pages |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Now we have our intiial commit on the |
||||
<code>gh-pages</code> branch.</p> |
||||
<h2 id="enabling-github-pages">Enabling Github Pages<a class="headerlink" href="#enabling-github-pages" title="Permanent link">¶</a></h2> |
||||
<p>We have one additional step to cover. |
||||
After we create the <code>gh-pages</code> branch, |
||||
we want to tell Github Pages that we have |
||||
web content on that branch that we want |
||||
Github to host. </p> |
||||
<p>Go to the repository settings, |
||||
and scroll down to the Github Pages |
||||
setting. Select the drop-down option |
||||
to host your Github Pages content |
||||
from the <code>gh-pages</code> branch.</p> |
||||
<p>Now visit the URL to check out your |
||||
Hello World page:</p> |
||||
<div class="codehilite"><pre><span></span>https://username.github.io/projectname |
||||
</pre></div> |
||||
|
||||
|
||||
<h2 id="adding-the-real-content">Adding the real content<a class="headerlink" href="#adding-the-real-content" title="Permanent link">¶</a></h2> |
||||
<p>We have a hello world page working, |
||||
now let's add the real Pelican content.</p> |
||||
<p>Back in the <code>pelican/</code> directory, |
||||
clean out the <code>output/</code> directory |
||||
(we'll be making everything from |
||||
scratch):</p> |
||||
<div class="codehilite"><pre><span></span>$ rm -rf output/* |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Don't remove the <code>output/</code> directory itself though!</p> |
||||
<p>Now make the content:</p> |
||||
<div class="codehilite"><pre><span></span>$ pelican content |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Now add the content to the <code>gh-pages</code> branch |
||||
and push it to Github to deploy it:</p> |
||||
<div class="codehilite"><pre><span></span>$ cd output/ |
||||
$ git add -A . |
||||
$ git commit -a -m 'Updating site' |
||||
$ git push origin gh-pages |
||||
</pre></div> |
||||
|
||||
|
||||
<p>This will push the new static site (this time with |
||||
the Pelican output) to the <code>gh-pages</code> branch on Github. |
||||
Sometimes the site updates really fast (few seconds), |
||||
sometimes it takes longer, but never more than about a minute.</p> |
||||
<p>Don't forget to add a link to your new page |
||||
in the repository description (and in your README) |
||||
to make it easier to find!</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
<a href="../Adding/" title="Adding Content" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Previous |
||||
</span> |
||||
Adding Content |
||||
</span> |
||||
</div> |
||||
</a> |
||||
|
||||
|
||||
</nav> |
||||
</div> |
||||
|
||||
<div class="md-footer-meta md-typeset"> |
||||
<div class="md-footer-meta__inner md-grid"> |
||||
<div class="md-footer-copyright"> |
||||
|
||||
<div class="md-footer-copyright__highlight"> |
||||
Copyright © 2018 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT license</a> |
||||
</div> |
||||
|
||||
powered by |
||||
<a href="https://www.mkdocs.org">MkDocs</a> |
||||
and |
||||
<a href="https://squidfunk.github.io/mkdocs-material/"> |
||||
Material for MkDocs</a> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
</footer> |
||||
|
||||
</div> |
||||
|
||||
<script src="../assets/javascripts/application.e72fd936.js"></script> |
||||
|
||||
<script>app.initialize({version:"1.0",url:{base:".."}})</script> |
||||
|
||||
<script src="../search/main.js"></script> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,20 +0,0 @@
@@ -1,20 +0,0 @@
|
||||
Copyright (c) 2018 Charles Reid |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all |
||||
copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
SOFTWARE. |
||||
|
||||
@ -1,9 +0,0 @@
@@ -1,9 +0,0 @@
|
||||
# how do I pelican? |
||||
|
||||
See [how do I pelican?](https://pages.charlesreid1.com/how-do-i-pelican) |
||||
(the website). |
||||
|
||||
Source repository on git.charlesreid1.com [here](https://git.charlesreid1.com/charlesreid1/how-do-i-pelican). |
||||
|
||||
Source repository on github [here](https://github.com/charlesreid1/how-do-i-pelican). |
||||
|
||||
@ -0,0 +1,493 @@
@@ -0,0 +1,493 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html> |
||||
<html lang="en" class="no-js"> |
||||
<head> |
||||
|
||||
<meta charset="utf-8"> |
||||
<meta name="viewport" content="width=device-width,initial-scale=1"> |
||||
<meta http-equiv="x-ua-compatible" content="ie=edge"> |
||||
|
||||
|
||||
<link rel="canonical" href="https://pages.charlesreid1.com/how-do-i-pelican/Serving/"> |
||||
|
||||
|
||||
|
||||
<meta name="lang:clipboard.copy" content="Copy to clipboard"> |
||||
|
||||
<meta name="lang:clipboard.copied" content="Copied to clipboard"> |
||||
|
||||
<meta name="lang:search.language" content="en"> |
||||
|
||||
<meta name="lang:search.pipeline.stopwords" content="True"> |
||||
|
||||
<meta name="lang:search.pipeline.trimmer" content="True"> |
||||
|
||||
<meta name="lang:search.result.none" content="No matching documents"> |
||||
|
||||
<meta name="lang:search.result.one" content="1 matching document"> |
||||
|
||||
<meta name="lang:search.result.other" content="# matching documents"> |
||||
|
||||
<meta name="lang:search.tokenizer" content="[\s\-]+"> |
||||
|
||||
<link rel="shortcut icon" href=".."> |
||||
<meta name="generator" content="mkdocs-1.0, mkdocs-material-3.0.3"> |
||||
|
||||
|
||||
|
||||
<title>Serving Your Static Site - how do I pelican?</title> |
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application.451f80e5.css"> |
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application-palette.22915126.css"> |
||||
|
||||
|
||||
|
||||
|
||||
<meta name="theme-color" content="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<script src="../assets/javascripts/modernizr.1aa3b519.js"></script> |
||||
|
||||
|
||||
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> |
||||
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT Mono","Courier New",Courier,monospace}</style> |
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/fonts/material-icons.css"> |
||||
|
||||
<link rel="stylesheet" href="../css/custom.css"> |
||||
|
||||
|
||||
</head> |
||||
|
||||
|
||||
|
||||
<body dir="ltr" data-md-color-primary="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</defs> |
||||
</svg> |
||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
||||
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label> |
||||
|
||||
<a href="../#serving-your-static-site" tabindex="1" class="md-skip"> |
||||
Skip to content |
||||
</a> |
||||
|
||||
|
||||
<header class="md-header" data-md-component="header"> |
||||
<nav class="md-header-nav md-grid"> |
||||
<div class="md-flex"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch"> |
||||
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> |
||||
|
||||
|
||||
<span class="md-header-nav__topic"> |
||||
how do I pelican? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Serving Your Static Site |
||||
</span> |
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
|
||||
|
||||
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> |
||||
|
||||
<div class="md-search" data-md-component="search" role="dialog"> |
||||
<label class="md-search__overlay" for="__search"></label> |
||||
<div class="md-search__inner" role="search"> |
||||
<form class="md-search__form" name="search"> |
||||
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> |
||||
<label class="md-icon md-search__icon" for="__search"></label> |
||||
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> |
||||
 |
||||
</button> |
||||
</form> |
||||
<div class="md-search__output"> |
||||
<div class="md-search__scrollwrap" data-md-scrollfix> |
||||
<div class="md-search-result" data-md-component="result"> |
||||
<div class="md-search-result__meta"> |
||||
Type to start searching |
||||
</div> |
||||
<ol class="md-search-result__list"></ol> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
</div> |
||||
|
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<div class="md-header-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
</div> |
||||
|
||||
</div> |
||||
</nav> |
||||
</header> |
||||
|
||||
<div class="md-container"> |
||||
|
||||
|
||||
|
||||
<main class="md-main"> |
||||
<div class="md-main__inner md-grid" data-md-component="container"> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
<nav class="md-nav md-nav--primary" data-md-level="0"> |
||||
<label class="md-nav__title md-nav__title--site" for="__drawer"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pelican? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href=".." title="Index" class="md-nav__link"> |
||||
Index |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Before/" title="Before You Start" class="md-nav__link"> |
||||
Before You Start |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Getting/" title="Getting Started with Pelican" class="md-nav__link"> |
||||
Getting Started with Pelican |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Configuring/" title="Configuring Your Pelican Site" class="md-nav__link"> |
||||
Configuring Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Theming/" title="Theming Your Pelican Site" class="md-nav__link"> |
||||
Theming Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Generating/" title="Generating Your Pelican Site" class="md-nav__link"> |
||||
Generating Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
|
||||
|
||||
<a href="./" title="Serving Your Static Site" class="md-nav__link md-nav__link--active"> |
||||
Serving Your Static Site |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Adding/" title="Adding Content" class="md-nav__link"> |
||||
Adding Content |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Hosting/" title="Hosting on Github Pages" class="md-nav__link"> |
||||
Hosting on Github Pages |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
</ul> |
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1 id="serving-your-static-site">Serving your static site<a class="headerlink" href="#serving-your-static-site" title="Permanent link">¶</a></h1> |
||||
<p>Once you've run the <code>pelican</code> command to generate |
||||
your static site, you'll want to see what it looks like. |
||||
To do this, you need to run a simple HTTP server - |
||||
nothing fancy. </p> |
||||
<p>(Now you can see the advantage of a static site.)</p> |
||||
<p>Run a simple HTTP server with python, which has a |
||||
built-in HTTP server that can be run from the |
||||
command line.</p> |
||||
<p>Run the server from the <code>output/</code> directory, |
||||
which contains the static content for your site.</p> |
||||
<div class="codehilite"><pre><span></span>$ cd pelican/output/ |
||||
|
||||
$ python -m http.server # serve content on localhost:8000 |
||||
|
||||
$ python -m http.server 8888 # serve content on localhost:8888 |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Now navigate to <code>localhost:8000</code> or <code>localhost:8888</code> |
||||
in your browser to view your static site.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
<a href="../Generating/" title="Generating Your Pelican Site" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Previous |
||||
</span> |
||||
Generating Your Pelican Site |
||||
</span> |
||||
</div> |
||||
</a> |
||||
|
||||
|
||||
<a href="../Adding/" title="Adding Content" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Next |
||||
</span> |
||||
Adding Content |
||||
</span> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
||||
</div> |
||||
</a> |
||||
|
||||
</nav> |
||||
</div> |
||||
|
||||
<div class="md-footer-meta md-typeset"> |
||||
<div class="md-footer-meta__inner md-grid"> |
||||
<div class="md-footer-copyright"> |
||||
|
||||
<div class="md-footer-copyright__highlight"> |
||||
Copyright © 2018 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT license</a> |
||||
</div> |
||||
|
||||
powered by |
||||
<a href="https://www.mkdocs.org">MkDocs</a> |
||||
and |
||||
<a href="https://squidfunk.github.io/mkdocs-material/"> |
||||
Material for MkDocs</a> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
</footer> |
||||
|
||||
</div> |
||||
|
||||
<script src="../assets/javascripts/application.e72fd936.js"></script> |
||||
|
||||
<script>app.initialize({version:"1.0",url:{base:".."}})</script> |
||||
|
||||
<script src="../search/main.js"></script> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
@ -0,0 +1,547 @@
@@ -0,0 +1,547 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html> |
||||
<html lang="en" class="no-js"> |
||||
<head> |
||||
|
||||
<meta charset="utf-8"> |
||||
<meta name="viewport" content="width=device-width,initial-scale=1"> |
||||
<meta http-equiv="x-ua-compatible" content="ie=edge"> |
||||
|
||||
|
||||
<link rel="canonical" href="https://pages.charlesreid1.com/how-do-i-pelican/Theming/"> |
||||
|
||||
|
||||
|
||||
<meta name="lang:clipboard.copy" content="Copy to clipboard"> |
||||
|
||||
<meta name="lang:clipboard.copied" content="Copied to clipboard"> |
||||
|
||||
<meta name="lang:search.language" content="en"> |
||||
|
||||
<meta name="lang:search.pipeline.stopwords" content="True"> |
||||
|
||||
<meta name="lang:search.pipeline.trimmer" content="True"> |
||||
|
||||
<meta name="lang:search.result.none" content="No matching documents"> |
||||
|
||||
<meta name="lang:search.result.one" content="1 matching document"> |
||||
|
||||
<meta name="lang:search.result.other" content="# matching documents"> |
||||
|
||||
<meta name="lang:search.tokenizer" content="[\s\-]+"> |
||||
|
||||
<link rel="shortcut icon" href=".."> |
||||
<meta name="generator" content="mkdocs-1.0, mkdocs-material-3.0.3"> |
||||
|
||||
|
||||
|
||||
<title>Theming Your Pelican Site - how do I pelican?</title> |
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application.451f80e5.css"> |
||||
|
||||
<link rel="stylesheet" href="../assets/stylesheets/application-palette.22915126.css"> |
||||
|
||||
|
||||
|
||||
|
||||
<meta name="theme-color" content="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<script src="../assets/javascripts/modernizr.1aa3b519.js"></script> |
||||
|
||||
|
||||
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> |
||||
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT Mono","Courier New",Courier,monospace}</style> |
||||
|
||||
|
||||
<link rel="stylesheet" href="../assets/fonts/material-icons.css"> |
||||
|
||||
<link rel="stylesheet" href="../css/custom.css"> |
||||
|
||||
|
||||
</head> |
||||
|
||||
|
||||
|
||||
<body dir="ltr" data-md-color-primary="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</defs> |
||||
</svg> |
||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
||||
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label> |
||||
|
||||
<a href="../#theming-your-pelican-site" tabindex="1" class="md-skip"> |
||||
Skip to content |
||||
</a> |
||||
|
||||
|
||||
<header class="md-header" data-md-component="header"> |
||||
<nav class="md-header-nav md-grid"> |
||||
<div class="md-flex"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch"> |
||||
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> |
||||
|
||||
|
||||
<span class="md-header-nav__topic"> |
||||
how do I pelican? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Theming Your Pelican Site |
||||
</span> |
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
|
||||
|
||||
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> |
||||
|
||||
<div class="md-search" data-md-component="search" role="dialog"> |
||||
<label class="md-search__overlay" for="__search"></label> |
||||
<div class="md-search__inner" role="search"> |
||||
<form class="md-search__form" name="search"> |
||||
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> |
||||
<label class="md-icon md-search__icon" for="__search"></label> |
||||
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> |
||||
 |
||||
</button> |
||||
</form> |
||||
<div class="md-search__output"> |
||||
<div class="md-search__scrollwrap" data-md-scrollfix> |
||||
<div class="md-search-result" data-md-component="result"> |
||||
<div class="md-search-result__meta"> |
||||
Type to start searching |
||||
</div> |
||||
<ol class="md-search-result__list"></ol> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
</div> |
||||
|
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<div class="md-header-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
</div> |
||||
|
||||
</div> |
||||
</nav> |
||||
</header> |
||||
|
||||
<div class="md-container"> |
||||
|
||||
|
||||
|
||||
<main class="md-main"> |
||||
<div class="md-main__inner md-grid" data-md-component="container"> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
<nav class="md-nav md-nav--primary" data-md-level="0"> |
||||
<label class="md-nav__title md-nav__title--site" for="__drawer"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pelican? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href=".." title="Index" class="md-nav__link"> |
||||
Index |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Before/" title="Before You Start" class="md-nav__link"> |
||||
Before You Start |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Getting/" title="Getting Started with Pelican" class="md-nav__link"> |
||||
Getting Started with Pelican |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Configuring/" title="Configuring Your Pelican Site" class="md-nav__link"> |
||||
Configuring Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc"> |
||||
Theming Your Pelican Site |
||||
</label> |
||||
|
||||
<a href="./" title="Theming Your Pelican Site" class="md-nav__link md-nav__link--active"> |
||||
Theming Your Pelican Site |
||||
</a> |
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#simple-bootstrap-theme" title="simple-bootstrap theme" class="md-nav__link"> |
||||
simple-bootstrap theme |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Generating/" title="Generating Your Pelican Site" class="md-nav__link"> |
||||
Generating Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Serving/" title="Serving Your Static Site" class="md-nav__link"> |
||||
Serving Your Static Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Adding/" title="Adding Content" class="md-nav__link"> |
||||
Adding Content |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../Hosting/" title="Hosting on Github Pages" class="md-nav__link"> |
||||
Hosting on Github Pages |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
</ul> |
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#simple-bootstrap-theme" title="simple-bootstrap theme" class="md-nav__link"> |
||||
simple-bootstrap theme |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1 id="theming-your-pelican-site">Theming your Pelican site<a class="headerlink" href="#theming-your-pelican-site" title="Permanent link">¶</a></h1> |
||||
<p>Custom themes are where Pelican becomes really powerful.</p> |
||||
<p>For this tutorial, though, we'll stick to the basics.</p> |
||||
<p>See <a href="https://github.com/getpelican/pelican-themes">pelican-themes</a> |
||||
on Github for a full list of themes.</p> |
||||
<p>See <a href="http://pelicanthemes.com/">pelicanthemes.com</a> |
||||
for a gallery of themes.</p> |
||||
<h2 id="simple-bootstrap-theme">simple-bootstrap theme<a class="headerlink" href="#simple-bootstrap-theme" title="Permanent link">¶</a></h2> |
||||
<p>For this example, we'll use the <a href="https://github.com/getpelican/pelican-themes/tree/master/simple-bootstrap">simple-bootstrap</a>, |
||||
a simple Bootstrap theme.</p> |
||||
<p>To use the simple-bootstrap theme, we have to install it. |
||||
Start by checking out the pelican-themes repo:</p> |
||||
<div class="codehilite"><pre><span></span>$ git clone --recursive https://github.com/getpelican/pelican-themes |
||||
|
||||
$ cd pelican-themes |
||||
|
||||
$ pelican-themes -i simple-bootstrap |
||||
</pre></div> |
||||
|
||||
|
||||
<p>If you modify or update the theme, you can |
||||
use the <code>-U</code> flag (for Update) with <code>pelican-themes</code>:</p> |
||||
<div class="codehilite"><pre><span></span>$ pelican-themes -U simple-bootstrap |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Now you can set the gum theme in your <code>pelicanconf.py</code> |
||||
by setting the <code>THEME</code> variable:</p> |
||||
<div class="codehilite"><pre><span></span>THEME="simple-bootstrap" |
||||
</pre></div> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
<a href="../Configuring/" title="Configuring Your Pelican Site" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Previous |
||||
</span> |
||||
Configuring Your Pelican Site |
||||
</span> |
||||
</div> |
||||
</a> |
||||
|
||||
|
||||
<a href="../Generating/" title="Generating Your Pelican Site" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Next |
||||
</span> |
||||
Generating Your Pelican Site |
||||
</span> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
||||
</div> |
||||
</a> |
||||
|
||||
</nav> |
||||
</div> |
||||
|
||||
<div class="md-footer-meta md-typeset"> |
||||
<div class="md-footer-meta__inner md-grid"> |
||||
<div class="md-footer-copyright"> |
||||
|
||||
<div class="md-footer-copyright__highlight"> |
||||
Copyright © 2018 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT license</a> |
||||
</div> |
||||
|
||||
powered by |
||||
<a href="https://www.mkdocs.org">MkDocs</a> |
||||
and |
||||
<a href="https://squidfunk.github.io/mkdocs-material/"> |
||||
Material for MkDocs</a> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
</footer> |
||||
|
||||
</div> |
||||
|
||||
<script src="../assets/javascripts/application.e72fd936.js"></script> |
||||
|
||||
<script>app.initialize({version:"1.0",url:{base:".."}})</script> |
||||
|
||||
<script src="../search/main.js"></script> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
File diff suppressed because one or more lines are too long
@ -0,0 +1,13 @@
@@ -0,0 +1,13 @@
|
||||
/*! |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not |
||||
* use this file except in compliance with the License. You may obtain a copy |
||||
* of the License at: |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0 |
||||
* |
||||
* UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, SOFTWARE |
||||
* DISTRIBUTED UNDER THE LICENSE IS DISTRIBUTED ON AN "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. |
||||
* SEE THE LICENSE FOR THE SPECIFIC LANGUAGE GOVERNING PERMISSIONS AND |
||||
* LIMITATIONS UNDER THE LICENSE. |
||||
*/@font-face{font-family:"Material Icons";font-style:normal;font-weight:400;src:local("Material Icons"),local("MaterialIcons-Regular"),url("specimen/MaterialIcons-Regular.woff2") format("woff2"),url("specimen/MaterialIcons-Regular.woff") format("woff"),url("specimen/MaterialIcons-Regular.ttf") format("truetype")} |
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 521 B |
|
After Width: | Height: | Size: 1.4 KiB |
|
After Width: | Height: | Size: 1.2 KiB |
|
After Width: | Height: | Size: 1.6 KiB |
File diff suppressed because one or more lines are too long
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r,i,n;e.da=function(){this.pipeline.reset(),this.pipeline.add(e.da.trimmer,e.da.stopWordFilter,e.da.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.da.stemmer))},e.da.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.da.trimmer=e.trimmerSupport.generateTrimmer(e.da.wordCharacters),e.Pipeline.registerFunction(e.da.trimmer,"trimmer-da"),e.da.stemmer=(r=e.stemmerSupport.Among,i=e.stemmerSupport.SnowballProgram,n=new function(){var e,n,t,s=[new r("hed",-1,1),new r("ethed",0,1),new r("ered",-1,1),new r("e",-1,1),new r("erede",3,1),new r("ende",3,1),new r("erende",5,1),new r("ene",3,1),new r("erne",3,1),new r("ere",3,1),new r("en",-1,1),new r("heden",10,1),new r("eren",10,1),new r("er",-1,1),new r("heder",13,1),new r("erer",13,1),new r("s",-1,2),new r("heds",16,1),new r("es",16,1),new r("endes",18,1),new r("erendes",19,1),new r("enes",18,1),new r("ernes",18,1),new r("eres",18,1),new r("ens",16,1),new r("hedens",24,1),new r("erens",24,1),new r("ers",16,1),new r("ets",16,1),new r("erets",28,1),new r("et",-1,1),new r("eret",30,1)],o=[new r("gd",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1)],a=[new r("ig",-1,1),new r("lig",0,1),new r("elig",1,1),new r("els",-1,1),new r("løst",-1,2)],d=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],u=[239,254,42,3,0,0,0,0,0,0,0,0,0,0,0,0,16],c=new i;function l(){var e,r=c.limit-c.cursor;c.cursor>=n&&(e=c.limit_backward,c.limit_backward=n,c.ket=c.cursor,c.find_among_b(o,4)?(c.bra=c.cursor,c.limit_backward=e,c.cursor=c.limit-r,c.cursor>c.limit_backward&&(c.cursor--,c.bra=c.cursor,c.slice_del())):c.limit_backward=e)}this.setCurrent=function(e){c.setCurrent(e)},this.getCurrent=function(){return c.getCurrent()},this.stem=function(){var r,i=c.cursor;return function(){var r,i=c.cursor+3;if(n=c.limit,0<=i&&i<=c.limit){for(e=i;;){if(r=c.cursor,c.in_grouping(d,97,248)){c.cursor=r;break}if(c.cursor=r,r>=c.limit)return;c.cursor++}for(;!c.out_grouping(d,97,248);){if(c.cursor>=c.limit)return;c.cursor++}(n=c.cursor)<e&&(n=e)}}(),c.limit_backward=i,c.cursor=c.limit,function(){var e,r;if(c.cursor>=n&&(r=c.limit_backward,c.limit_backward=n,c.ket=c.cursor,e=c.find_among_b(s,32),c.limit_backward=r,e))switch(c.bra=c.cursor,e){case 1:c.slice_del();break;case 2:c.in_grouping_b(u,97,229)&&c.slice_del()}}(),c.cursor=c.limit,l(),c.cursor=c.limit,function(){var e,r,i,t=c.limit-c.cursor;if(c.ket=c.cursor,c.eq_s_b(2,"st")&&(c.bra=c.cursor,c.eq_s_b(2,"ig")&&c.slice_del()),c.cursor=c.limit-t,c.cursor>=n&&(r=c.limit_backward,c.limit_backward=n,c.ket=c.cursor,e=c.find_among_b(a,5),c.limit_backward=r,e))switch(c.bra=c.cursor,e){case 1:c.slice_del(),i=c.limit-c.cursor,l(),c.cursor=c.limit-i;break;case 2:c.slice_from("løs")}}(),c.cursor=c.limit,c.cursor>=n&&(r=c.limit_backward,c.limit_backward=n,c.ket=c.cursor,c.out_grouping_b(d,97,248)?(c.bra=c.cursor,t=c.slice_to(t),c.limit_backward=r,c.eq_v_b(t)&&c.slice_del()):c.limit_backward=r),!0}},function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}),e.Pipeline.registerFunction(e.da.stemmer,"stemmer-da"),e.da.stopWordFilter=e.generateStopWordFilter("ad af alle alt anden at blev blive bliver da de dem den denne der deres det dette dig din disse dog du efter eller en end er et for fra ham han hans har havde have hende hendes her hos hun hvad hvis hvor i ikke ind jeg jer jo kunne man mange med meget men mig min mine mit mod ned noget nogle nu når og også om op os over på selv sig sin sine sit skal skulle som sådan thi til ud under var vi vil ville vor være været".split(" ")),e.Pipeline.registerFunction(e.da.stopWordFilter,"stopWordFilter-da")}}); |
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r="2"==e.version[0];e.jp=function(){this.pipeline.reset(),this.pipeline.add(e.jp.stopWordFilter,e.jp.stemmer),r?this.tokenizer=e.jp.tokenizer:(e.tokenizer&&(e.tokenizer=e.jp.tokenizer),this.tokenizerFn&&(this.tokenizerFn=e.jp.tokenizer))};var t=new e.TinySegmenter;e.jp.tokenizer=function(n){if(!arguments.length||null==n||null==n)return[];if(Array.isArray(n))return n.map(function(t){return r?new e.Token(t.toLowerCase()):t.toLowerCase()});for(var i=n.toString().toLowerCase().replace(/^\s+/,""),o=i.length-1;o>=0;o--)if(/\S/.test(i.charAt(o))){i=i.substring(0,o+1);break}return t.segment(i).filter(function(e){return!!e}).map(function(t){return r?new e.Token(t):t})},e.jp.stemmer=function(e){return e},e.Pipeline.registerFunction(e.jp.stemmer,"stemmer-jp"),e.jp.wordCharacters="一二三四五六七八九十百千万億兆一-龠々〆ヵヶぁ-んァ-ヴーｱ-ﾝﾞa-zA-Zａ-ｚＡ-Ｚ0-9０-９",e.jp.stopWordFilter=function(t){if(-1===e.jp.stopWordFilter.stopWords.indexOf(r?t.toString():t))return t},e.jp.stopWordFilter=e.generateStopWordFilter("これ それ あれ この その あの ここ そこ あそこ こちら どこ だれ なに なん 何 私 貴方 貴方方 我々 私達 あの人 あのかた 彼女 彼 です あります おります います は が の に を で え から まで より も どの と し それで しかし".split(" ")),e.Pipeline.registerFunction(e.jp.stopWordFilter,"stopWordFilter-jp")}}); |
||||
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(e,i){"function"==typeof define&&define.amd?define(i):"object"==typeof exports?module.exports=i():i()(e.lunr)}(this,function(){return function(e){e.multiLanguage=function(){for(var i=Array.prototype.slice.call(arguments),t=i.join("-"),r="",n=[],s=[],p=0;p<i.length;++p)"en"==i[p]?(r+="\\w",n.unshift(e.stopWordFilter),n.push(e.stemmer),s.push(e.stemmer)):(r+=e[i[p]].wordCharacters,n.unshift(e[i[p]].stopWordFilter),n.push(e[i[p]].stemmer),s.push(e[i[p]].stemmer));var o=e.trimmerSupport.generateTrimmer(r);return e.Pipeline.registerFunction(o,"lunr-multi-trimmer-"+t),n.unshift(o),function(){this.pipeline.reset(),this.pipeline.add.apply(this.pipeline,n),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add.apply(this.searchPipeline,s))}}}}); |
||||
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r,n,i;e.no=function(){this.pipeline.reset(),this.pipeline.add(e.no.trimmer,e.no.stopWordFilter,e.no.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.no.stemmer))},e.no.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.no.trimmer=e.trimmerSupport.generateTrimmer(e.no.wordCharacters),e.Pipeline.registerFunction(e.no.trimmer,"trimmer-no"),e.no.stemmer=(r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){var e,i,t=[new r("a",-1,1),new r("e",-1,1),new r("ede",1,1),new r("ande",1,1),new r("ende",1,1),new r("ane",1,1),new r("ene",1,1),new r("hetene",6,1),new r("erte",1,3),new r("en",-1,1),new r("heten",9,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",12,1),new r("s",-1,2),new r("as",14,1),new r("es",14,1),new r("edes",16,1),new r("endes",16,1),new r("enes",16,1),new r("hetenes",19,1),new r("ens",14,1),new r("hetens",21,1),new r("ers",14,1),new r("ets",14,1),new r("et",-1,1),new r("het",25,1),new r("ert",-1,3),new r("ast",-1,1)],o=[new r("dt",-1,-1),new r("vt",-1,-1)],s=[new r("leg",-1,1),new r("eleg",0,1),new r("ig",-1,1),new r("eig",2,1),new r("lig",2,1),new r("elig",4,1),new r("els",-1,1),new r("lov",-1,1),new r("elov",7,1),new r("slov",7,1),new r("hetslov",9,1)],a=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],m=[119,125,149,1],l=new n;this.setCurrent=function(e){l.setCurrent(e)},this.getCurrent=function(){return l.getCurrent()},this.stem=function(){var r,n,u,d,c=l.cursor;return function(){var r,n=l.cursor+3;if(i=l.limit,0<=n||n<=l.limit){for(e=n;;){if(r=l.cursor,l.in_grouping(a,97,248)){l.cursor=r;break}if(r>=l.limit)return;l.cursor=r+1}for(;!l.out_grouping(a,97,248);){if(l.cursor>=l.limit)return;l.cursor++}(i=l.cursor)<e&&(i=e)}}(),l.limit_backward=c,l.cursor=l.limit,function(){var e,r,n;if(l.cursor>=i&&(r=l.limit_backward,l.limit_backward=i,l.ket=l.cursor,e=l.find_among_b(t,29),l.limit_backward=r,e))switch(l.bra=l.cursor,e){case 1:l.slice_del();break;case 2:n=l.limit-l.cursor,l.in_grouping_b(m,98,122)?l.slice_del():(l.cursor=l.limit-n,l.eq_s_b(1,"k")&&l.out_grouping_b(a,97,248)&&l.slice_del());break;case 3:l.slice_from("er")}}(),l.cursor=l.limit,n=l.limit-l.cursor,l.cursor>=i&&(r=l.limit_backward,l.limit_backward=i,l.ket=l.cursor,l.find_among_b(o,2)?(l.bra=l.cursor,l.limit_backward=r,l.cursor=l.limit-n,l.cursor>l.limit_backward&&(l.cursor--,l.bra=l.cursor,l.slice_del())):l.limit_backward=r),l.cursor=l.limit,l.cursor>=i&&(d=l.limit_backward,l.limit_backward=i,l.ket=l.cursor,(u=l.find_among_b(s,11))?(l.bra=l.cursor,l.limit_backward=d,1==u&&l.slice_del()):l.limit_backward=d),!0}},function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}),e.Pipeline.registerFunction(e.no.stemmer,"stemmer-no"),e.no.stopWordFilter=e.generateStopWordFilter("alle at av bare begge ble blei bli blir blitt både båe da de deg dei deim deira deires dem den denne der dere deres det dette di din disse ditt du dykk dykkar då eg ein eit eitt eller elles en enn er et ett etter for fordi fra før ha hadde han hans har hennar henne hennes her hjå ho hoe honom hoss hossen hun hva hvem hver hvilke hvilken hvis hvor hvordan hvorfor i ikke ikkje ikkje ingen ingi inkje inn inni ja jeg kan kom korleis korso kun kunne kva kvar kvarhelst kven kvi kvifor man mange me med medan meg meget mellom men mi min mine mitt mot mykje ned no noe noen noka noko nokon nokor nokre nå når og også om opp oss over på samme seg selv si si sia sidan siden sin sine sitt sjøl skal skulle slik so som som somme somt så sånn til um upp ut uten var vart varte ved vere verte vi vil ville vore vors vort vår være være vært å".split(" ")),e.Pipeline.registerFunction(e.no.stopWordFilter,"stopWordFilter-no")}}); |
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(r,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():t()(r.lunr)}(this,function(){return function(r){r.stemmerSupport={Among:function(r,t,i,s){if(this.toCharArray=function(r){for(var t=r.length,i=new Array(t),s=0;s<t;s++)i[s]=r.charCodeAt(s);return i},!r&&""!=r||!t&&0!=t||!i)throw"Bad Among initialisation: s:"+r+", substring_i: "+t+", result: "+i;this.s_size=r.length,this.s=this.toCharArray(r),this.substring_i=t,this.result=i,this.method=s},SnowballProgram:function(){var r;return{bra:0,ket:0,limit:0,cursor:0,limit_backward:0,setCurrent:function(t){r=t,this.cursor=0,this.limit=t.length,this.limit_backward=0,this.bra=this.cursor,this.ket=this.limit},getCurrent:function(){var t=r;return r=null,t},in_grouping:function(t,i,s){if(this.cursor<this.limit){var e=r.charCodeAt(this.cursor);if(e<=s&&e>=i&&t[(e-=i)>>3]&1<<(7&e))return this.cursor++,!0}return!1},in_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e<=s&&e>=i&&t[(e-=i)>>3]&1<<(7&e))return this.cursor--,!0}return!1},out_grouping:function(t,i,s){if(this.cursor<this.limit){var e=r.charCodeAt(this.cursor);if(e>s||e<i)return this.cursor++,!0;if(!(t[(e-=i)>>3]&1<<(7&e)))return this.cursor++,!0}return!1},out_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e>s||e<i)return this.cursor--,!0;if(!(t[(e-=i)>>3]&1<<(7&e)))return this.cursor--,!0}return!1},eq_s:function(t,i){if(this.limit-this.cursor<t)return!1;for(var s=0;s<t;s++)if(r.charCodeAt(this.cursor+s)!=i.charCodeAt(s))return!1;return this.cursor+=t,!0},eq_s_b:function(t,i){if(this.cursor-this.limit_backward<t)return!1;for(var s=0;s<t;s++)if(r.charCodeAt(this.cursor-t+s)!=i.charCodeAt(s))return!1;return this.cursor-=t,!0},find_among:function(t,i){for(var s=0,e=i,n=this.cursor,u=this.limit,o=0,h=0,c=!1;;){for(var a=s+(e-s>>1),f=0,l=o<h?o:h,_=t[a],m=l;m<_.s_size;m++){if(n+l==u){f=-1;break}if(f=r.charCodeAt(n+l)-_.s[m])break;l++}if(f<0?(e=a,h=l):(s=a,o=l),e-s<=1){if(s>0||e==s||c)break;c=!0}}for(;;){if(o>=(_=t[s]).s_size){if(this.cursor=n+_.s_size,!_.method)return _.result;var b=_.method();if(this.cursor=n+_.s_size,b)return _.result}if((s=_.substring_i)<0)return 0}},find_among_b:function(t,i){for(var s=0,e=i,n=this.cursor,u=this.limit_backward,o=0,h=0,c=!1;;){for(var a=s+(e-s>>1),f=0,l=o<h?o:h,_=(m=t[a]).s_size-1-l;_>=0;_--){if(n-l==u){f=-1;break}if(f=r.charCodeAt(n-1-l)-m.s[_])break;l++}if(f<0?(e=a,h=l):(s=a,o=l),e-s<=1){if(s>0||e==s||c)break;c=!0}}for(;;){var m;if(o>=(m=t[s]).s_size){if(this.cursor=n-m.s_size,!m.method)return m.result;var b=m.method();if(this.cursor=n-m.s_size,b)return m.result}if((s=m.substring_i)<0)return 0}},replace_s:function(t,i,s){var e=s.length-(i-t),n=r.substring(0,t),u=r.substring(i);return r=n+s+u,this.limit+=e,this.cursor>=i?this.cursor+=e:this.cursor>t&&(this.cursor=t),e},slice_check:function(){if(this.bra<0||this.bra>this.ket||this.ket>this.limit||this.limit>r.length)throw"faulty slice operation"},slice_from:function(r){this.slice_check(),this.replace_s(this.bra,this.ket,r)},slice_del:function(){this.slice_from("")},insert:function(r,t,i){var s=this.replace_s(r,t,i);r<=this.bra&&(this.bra+=s),r<=this.ket&&(this.ket+=s)},slice_to:function(){return this.slice_check(),r.substring(this.bra,this.ket)},eq_v_b:function(r){return this.eq_s_b(r.length,r)}}}},r.trimmerSupport={generateTrimmer:function(r){var t=new RegExp("^[^"+r+"]+"),i=new RegExp("[^"+r+"]+$");return function(r){return"function"==typeof r.update?r.update(function(r){return r.replace(t,"").replace(i,"")}):r.replace(t,"").replace(i,"")}}}}}); |
||||
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r,n,t;e.sv=function(){this.pipeline.reset(),this.pipeline.add(e.sv.trimmer,e.sv.stopWordFilter,e.sv.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.sv.stemmer))},e.sv.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.sv.trimmer=e.trimmerSupport.generateTrimmer(e.sv.wordCharacters),e.Pipeline.registerFunction(e.sv.trimmer,"trimmer-sv"),e.sv.stemmer=(r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,t=new function(){var e,t,i=[new r("a",-1,1),new r("arna",0,1),new r("erna",0,1),new r("heterna",2,1),new r("orna",0,1),new r("ad",-1,1),new r("e",-1,1),new r("ade",6,1),new r("ande",6,1),new r("arne",6,1),new r("are",6,1),new r("aste",6,1),new r("en",-1,1),new r("anden",12,1),new r("aren",12,1),new r("heten",12,1),new r("ern",-1,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",18,1),new r("or",-1,1),new r("s",-1,2),new r("as",21,1),new r("arnas",22,1),new r("ernas",22,1),new r("ornas",22,1),new r("es",21,1),new r("ades",26,1),new r("andes",26,1),new r("ens",21,1),new r("arens",29,1),new r("hetens",29,1),new r("erns",21,1),new r("at",-1,1),new r("andet",-1,1),new r("het",-1,1),new r("ast",-1,1)],s=[new r("dd",-1,-1),new r("gd",-1,-1),new r("nn",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1),new r("tt",-1,-1)],a=[new r("ig",-1,1),new r("lig",0,1),new r("els",-1,1),new r("fullt",-1,3),new r("löst",-1,2)],o=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,24,0,32],u=[119,127,149],m=new n;this.setCurrent=function(e){m.setCurrent(e)},this.getCurrent=function(){return m.getCurrent()},this.stem=function(){var r,n=m.cursor;return function(){var r,n=m.cursor+3;if(t=m.limit,0<=n||n<=m.limit){for(e=n;;){if(r=m.cursor,m.in_grouping(o,97,246)){m.cursor=r;break}if(m.cursor=r,m.cursor>=m.limit)return;m.cursor++}for(;!m.out_grouping(o,97,246);){if(m.cursor>=m.limit)return;m.cursor++}(t=m.cursor)<e&&(t=e)}}(),m.limit_backward=n,m.cursor=m.limit,function(){var e,r=m.limit_backward;if(m.cursor>=t&&(m.limit_backward=t,m.cursor=m.limit,m.ket=m.cursor,e=m.find_among_b(i,37),m.limit_backward=r,e))switch(m.bra=m.cursor,e){case 1:m.slice_del();break;case 2:m.in_grouping_b(u,98,121)&&m.slice_del()}}(),m.cursor=m.limit,r=m.limit_backward,m.cursor>=t&&(m.limit_backward=t,m.cursor=m.limit,m.find_among_b(s,7)&&(m.cursor=m.limit,m.ket=m.cursor,m.cursor>m.limit_backward&&(m.bra=--m.cursor,m.slice_del())),m.limit_backward=r),m.cursor=m.limit,function(){var e,r;if(m.cursor>=t){if(r=m.limit_backward,m.limit_backward=t,m.cursor=m.limit,m.ket=m.cursor,e=m.find_among_b(a,5))switch(m.bra=m.cursor,e){case 1:m.slice_del();break;case 2:m.slice_from("lös");break;case 3:m.slice_from("full")}m.limit_backward=r}}(),!0}},function(e){return"function"==typeof e.update?e.update(function(e){return t.setCurrent(e),t.stem(),t.getCurrent()}):(t.setCurrent(e),t.stem(),t.getCurrent())}),e.Pipeline.registerFunction(e.sv.stemmer,"stemmer-sv"),e.sv.stopWordFilter=e.generateStopWordFilter("alla allt att av blev bli blir blivit de dem den denna deras dess dessa det detta dig din dina ditt du där då efter ej eller en er era ert ett från för ha hade han hans har henne hennes hon honom hur här i icke ingen inom inte jag ju kan kunde man med mellan men mig min mina mitt mot mycket ni nu när någon något några och om oss på samma sedan sig sin sina sitta själv skulle som så sådan sådana sådant till under upp ut utan vad var vara varför varit varje vars vart vem vi vid vilka vilkas vilken vilket vår våra vårt än är åt över".split(" ")),e.Pipeline.registerFunction(e.sv.stopWordFilter,"stopWordFilter-sv")}}); |
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,108 +0,0 @@
@@ -1,108 +0,0 @@
|
||||
# Adding content to your site |
||||
|
||||
Now that you have generated your site with the |
||||
`pelican` command, and have used Python to serve |
||||
your documentation with a simple HTTP server, |
||||
you have all the tools you need to start creating |
||||
content for your website. |
||||
|
||||
Also see [writing content](http://docs.getpelican.com/en/stable/content.html) |
||||
page of pelican documentation. |
||||
|
||||
Pelican has two types of content: pages (unchanging, no chronology) |
||||
and articles (blog posts). We will cover each below. |
||||
|
||||
## Adding blog posts to your site |
||||
|
||||
Let's cover how you add new content to your site. |
||||
|
||||
By default, Pelican is set up to create blog sites, |
||||
so we'll cover how to create a blog. Creating static |
||||
sites requires custom themes, and we won't get into that |
||||
in this document. |
||||
|
||||
In the `content/` directory (or `content/posts/` directory), |
||||
you create blog posts by adding Markdown files, and specify |
||||
metadata using a YAML header. |
||||
|
||||
Here's a Markdown template for a blog post: |
||||
|
||||
``` |
||||
Title: My super title |
||||
Date: 2010-12-03 10:20 |
||||
Modified: 2010-12-05 19:30 |
||||
Category: Python |
||||
Tags: pelican, publishing |
||||
Slug: my-super-post |
||||
Authors: Alexis Metaireau, Conan Doyle |
||||
Summary: Short version for index and feeds |
||||
|
||||
This is the content of my super blog post. |
||||
``` |
||||
|
||||
Note that not everything is necessary (e.g., Slug, Authors, Summary). |
||||
Ultimately the variables in the YAML headers of each |
||||
blog post are passed to the theme's page templates, |
||||
so what information gets used depends on the theme |
||||
that you use. |
||||
|
||||
## Adding pages to your site |
||||
|
||||
Metadata for |
||||
|
||||
## Linking to other pages |
||||
|
||||
As shown in the [linking to internal content](http://docs.getpelican.com/en/stable/content.html#linking-to-internal-content) |
||||
section of the pelican docs, you can link to other files |
||||
|
||||
**`article1.md`:** |
||||
|
||||
```plain |
||||
Title: The first article |
||||
Date: 2012-12-01 10:02 |
||||
|
||||
See below intra-site link examples in Markdown format. |
||||
|
||||
[a link to another file]({filename}/article2.md) |
||||
``` |
||||
|
||||
**`article2.md`:** |
||||
|
||||
```plain |
||||
Title: The second article |
||||
Date: 2012-12-01 10:02 |
||||
|
||||
More markdown goes _here_. |
||||
|
||||
[link back to article one]({filename}/article1.md) |
||||
``` |
||||
|
||||
See [docs](http://docs.getpelican.com/en/stable/content.html#linking-to-internal-content) for details. |
||||
|
||||
|
||||
## Linking to static files |
||||
|
||||
For example, a project’s content directory might be structured like this: |
||||
|
||||
Suppose you have a directory structure like this: |
||||
|
||||
``` |
||||
content |
||||
├── images |
||||
│ └── han.jpg |
||||
├── pdfs |
||||
│ └── menu.pdf |
||||
└── pages |
||||
└── test.md |
||||
``` |
||||
|
||||
then in `test.md` you would link to other files like this: |
||||
|
||||
``` |
||||
 |
||||
[Our Menu]({filename}/pdfs/menu.pdf) |
||||
``` |
||||
|
||||
See [docs](http://docs.getpelican.com/en/stable/content.html#linking-to-internal-content) |
||||
for details... |
||||
|
||||
@ -1,14 +0,0 @@
@@ -1,14 +0,0 @@
|
||||
## Before You Start |
||||
|
||||
You'll need to have [Pelican](https://github.com/getpelican/pelican) installed. |
||||
If you want to use Markdown with Pelican, |
||||
you'll also need to install Markdown. |
||||
|
||||
```text |
||||
$ pip install Markdown |
||||
$ pip install pelican |
||||
``` |
||||
|
||||
Also see [installation page](http://docs.getpelican.com/en/stable/install.html) |
||||
of Pelican documentation. |
||||
|
||||
@ -1,70 +0,0 @@
@@ -1,70 +0,0 @@
|
||||
## Configuring Your Pelican Site |
||||
|
||||
The `pelicanconf.py` file contains all configuration variables |
||||
that [Pelican](https://github.com/getpelican/pelican) sites need to set. |
||||
|
||||
Some of the configuration variables are common to all Pelican sites, |
||||
others are particular to the theme you are using. |
||||
|
||||
Here's an example configuration file from |
||||
[magic-flying-pelican](https://github.com/charlesreid1/magic-flying-pelican): |
||||
|
||||
**`pelicanconf.py`:** |
||||
|
||||
```python |
||||
AUTHOR = 'charlesreid1' |
||||
SITENAME = 'how-do-i-pelican' |
||||
SITEURL = '' |
||||
PATH = 'content' |
||||
TIMEZONE = 'America/Los_Angeles' |
||||
DEFAULT_LANG = 'en' |
||||
|
||||
# --------------8<--------------------- |
||||
# Theme |
||||
|
||||
THEME = 'simple-bootstrap' |
||||
# https://github.com/getpelican/pelican-themes/tree/master/simple-bootstrap |
||||
|
||||
|
||||
# --------------8<--------------------- |
||||
# Files and content |
||||
|
||||
|
||||
# This will look for a directory img/ |
||||
# inside the directory content/ |
||||
# The contents of img/ will be available at |
||||
# {{ SITEURL }}/img |
||||
STATIC_PATHS = ['img'] |
||||
|
||||
# If we want to create static pages, |
||||
# we should put them in content/pages |
||||
PAGE_PATHS = ['pages'] |
||||
|
||||
# If we want to create blog posts (articles), |
||||
# we should put them in content/posts |
||||
ARTICLE_PATHS = ['posts'] |
||||
|
||||
|
||||
# --------------8<--------------------- |
||||
# idk just some dumb stuff |
||||
|
||||
DISPLAY_PAGES_ON_MENU = False |
||||
FEED_ALL_ATOM = None |
||||
CATEGORY_FEED_ATOM = None |
||||
TRANSLATION_FEED_ATOM = None |
||||
AUTHOR_FEED_ATOM = None |
||||
AUTHOR_FEED_RSS = None |
||||
DEFAULT_PAGINATION = False |
||||
``` |
||||
|
||||
This will configure the `content/` directory |
||||
to contain a `posts/` folder with blog posts |
||||
and a `pages/` folder with static pages. |
||||
|
||||
There's a lot more that can be done with the |
||||
configuration file, but much of it requires |
||||
custom themes, so we'll leave it at that. |
||||
|
||||
See the [settings page](http://docs.getpelican.com/en/stable/settings.html?highlight=configuration) |
||||
of the pelican documentation for details. |
||||
|
||||
@ -1,36 +0,0 @@
@@ -1,36 +0,0 @@
|
||||
# Generating your static site |
||||
|
||||
To generate your static site with [Pelican](https://github.com/getpelican/pelican), |
||||
use the `pelican content` command, run from |
||||
the `pelican/` directory (see [getting started](Getting.md) |
||||
for a guide to the pelican directory layout): |
||||
|
||||
```plain |
||||
$ pelican |
||||
``` |
||||
|
||||
This will generate the static site content into |
||||
the `output/` folder. |
||||
|
||||
Inputs: `content/` |
||||
|
||||
Output: `output/` |
||||
|
||||
To modify the input folder, change the `PATH` variable |
||||
in `pelicanconf.py`: |
||||
|
||||
```plain |
||||
PATH = 'my_custom_content_dir' |
||||
``` |
||||
|
||||
To modify the output directory, set the |
||||
`OUTPUT_PATH` variable in `pelicanconf.py`: |
||||
|
||||
```plain |
||||
OUTPUT_PATH = 'my_custom_output_dir' |
||||
``` |
||||
|
||||
See the [settings page](http://docs.getpelican.com/en/stable/settings.html) |
||||
of the pelican documentation for more variables |
||||
that can be set in the `pelicanconf.py` file. |
||||
|
||||
@ -1,135 +0,0 @@
@@ -1,135 +0,0 @@
|
||||
# Getting Started with Pelican |
||||
|
||||
There are a few things you'll need to get started with [Pelican](https://github.com/getpelican/pelican): |
||||
|
||||
* (required) `pelicanconf.py` - pelican configuration file |
||||
* (required) `content/` - directory containing materials to render into a static site |
||||
* (optional) theme - either a local directory containing a theme, or a system-wide pelican theme |
||||
|
||||
Use the [magic-flying-pelican](https://github.com/charlesreid1/magic-flying-pelican) |
||||
repository as a seed repo for getting started with Pelican. |
||||
|
||||
Basically, copy the contents of the `pelican/` directory |
||||
in [magic-flying-pelican](https://github.com/charlesreid1/magic-flying-pelican) |
||||
into your own repository, and modify the contents for |
||||
your own static site. |
||||
|
||||
We'll walk through what the `pelican/` directory contains and what you |
||||
need to change to get a simple static site up and running. |
||||
|
||||
## How Pelican Works |
||||
|
||||
Let's cover the 101 of how Pelican works. |
||||
|
||||
Pelican takes a pile of HTML, markdown, and other files, |
||||
and compiles them into a static site. (The advantage of |
||||
using a static site instead of a dynamic server like |
||||
Flask or a dynamic language like PHP is speed.) |
||||
|
||||
To do that, it reads configuration settings from |
||||
`pelicanconf.py`, which tell Pelican where to look |
||||
for the raw files, as well as other settings like |
||||
the theme to use. |
||||
|
||||
The default location of content is the `content/` |
||||
directory, but more can be added. |
||||
|
||||
The default behavior for Pelican is to serve a blog |
||||
with a few static pages, but users can define themes |
||||
that are static pages only (no blog component). |
||||
|
||||
The themes work by providing a set of static files |
||||
and a set of HTML Jinja templates. Pelican uses |
||||
the static content and the theme to render the |
||||
final page. |
||||
|
||||
See [pelican-themes](https://github.com/getpelican/pelican-themes) |
||||
repository for themes. |
||||
|
||||
See [live gallery](http://www.pelicanthemes.com/) |
||||
of pelican themes. |
||||
|
||||
|
||||
## Repository and Branch Layout |
||||
|
||||
When using Pelican to create a static site on Github Pages, |
||||
you will need to organize your repository and set up |
||||
branches as follows. |
||||
|
||||
### Recommended way: project page |
||||
|
||||
If you are hosting a project Github Pages site |
||||
(that is, a Github Pages page for any arbitrary |
||||
Github project), you should organize your repo |
||||
as follows: |
||||
|
||||
* `gh-pages` branch contains all static content |
||||
* `master` branch contains the pelican site |
||||
|
||||
### Uncommon way: personal page |
||||
|
||||
If you are hosting a personal Github Pages site |
||||
(a repository under the account `@yourusername` |
||||
called `yourusername.github.io`), this should be |
||||
organized as follows: |
||||
|
||||
* `master` branch contains all static content |
||||
* `source` branch contains the `pelican/` directory |
||||
|
||||
### Clean way: pelican as a separate branch |
||||
|
||||
If you have a large project or you really don't want |
||||
to clutter your repository branch with Pelican files, |
||||
you can also set up a three-branch model as follows: |
||||
|
||||
* `master` branch contains the source code for your project (no Pelican files) |
||||
* `source` branch contains the Pelican files for your site |
||||
* `gh-pages` contains all static content for the Github Pages page |
||||
|
||||
|
||||
## Directory Layout |
||||
|
||||
While Pelican is flexible enough to handle many |
||||
directory layouts, let's cover a common pattern: |
||||
putting markdown files into `content/`. |
||||
|
||||
``` |
||||
my-cool-project/ |
||||
|
||||
pelican/ |
||||
|
||||
pelicanconf.py |
||||
|
||||
output/ |
||||
index.html |
||||
... |
||||
|
||||
content/ |
||||
posts/ |
||||
blog-post-1.md |
||||
blog-post-2.md |
||||
blog-post-3.md |
||||
pages/ |
||||
faq.md |
||||
about.md |
||||
contact.md |
||||
img/ |
||||
my-image-1.jpg |
||||
my-image-2.jpg |
||||
my-image-3.jpg |
||||
``` |
||||
|
||||
The pelican directory contains a configuration |
||||
file `pelicanconf.py`, a folder with content |
||||
`content/`, and an output directory `output/` |
||||
where the final static files for the site go. |
||||
(See [configuring](Configuring.md)). |
||||
|
||||
The `output/` directory will not be present |
||||
until you generate site content (see [generating](Generating.md)). |
||||
|
||||
The `output/` directory should be ignored by git. |
||||
In a later section of this document we will cover |
||||
a pattern for linking output to a Github Pages |
||||
site (see [workflow: update](#) WorkflowUpdate.md). |
||||
|
||||
@ -1,168 +0,0 @@
@@ -1,168 +0,0 @@
|
||||
# Hosting on Github Pages |
||||
|
||||
Now that you've configured your [Pelican](https://github.com/getpelican/pelican) site, |
||||
created your content, viewed it, modified it, |
||||
and are happy with it, you're ready to deploy |
||||
your site somewhere viewable by the public. |
||||
|
||||
Enter Github Pages. |
||||
|
||||
Github provides free web hosting for static content |
||||
for _every single repository on Github_. |
||||
That means you can deploy your static site |
||||
to Github Pages for no-hassle serverless |
||||
web hosting. |
||||
|
||||
(Also see the [publish](http://docs.getpelican.com/en/stable/publish.html) |
||||
page of the pelican documentation.) |
||||
|
||||
## Differences between personal and project pages |
||||
|
||||
In this walkthrough we assume the most common scenario |
||||
of deploying a page on Github Pages for a project. |
||||
|
||||
Setting up a personal page requires changing |
||||
branch names - see [getting started](Getting.md) |
||||
and the section on branches in particular. |
||||
Change `gh-pages` to `master` and `master` to `source`. |
||||
|
||||
The rest of the document will assume you are creating |
||||
a project page. |
||||
|
||||
## Where is it? |
||||
|
||||
Where do Github Pages live? |
||||
|
||||
If your username is `username` and your project name is `projectname`, |
||||
the Github source code is at: |
||||
|
||||
``` |
||||
https://github.com/username/projectname |
||||
``` |
||||
|
||||
and the Github Pages page will be at: |
||||
|
||||
``` |
||||
https://username.github.io/projectname |
||||
``` |
||||
|
||||
|
||||
## Initializing gh-pages branch |
||||
|
||||
Before you begin, you have to create a `gh-pages` branch. |
||||
We want to create a new branch that is _completely independent_ |
||||
of all other branches, because this branch will only contain |
||||
the static content of our website - no code, no readmes, |
||||
nothing but HTML, CSS, and Javascript. |
||||
|
||||
We want to link the `gh-pages` branch, which will contain |
||||
the site's static content, with the `output/` directory, |
||||
where Pelican generates all of its static content. |
||||
|
||||
Remove the output directory, and clone a copy of |
||||
your repo to the output directory: |
||||
|
||||
``` |
||||
$ cd pelican/ |
||||
$ rm -rf output/ |
||||
$ git clone https://github.com/username/projectname.git output |
||||
$ cd output/ |
||||
``` |
||||
|
||||
Now create a new orphan branch - that's the git terminology |
||||
for a branch that shares no history with any other branches. |
||||
Call it `gh-pages`: |
||||
|
||||
``` |
||||
$ git checkout --orphan gh-pages |
||||
``` |
||||
|
||||
Now all the content that was in the master branch |
||||
will show up as untracked files, because the new |
||||
`gh-pages` branch is totally empty. |
||||
|
||||
Remove everything in the directory except |
||||
the `.git` directory: |
||||
|
||||
``` |
||||
$ rm -rf * |
||||
$ rm -rf .gitignore .gitmodules |
||||
``` |
||||
|
||||
Now add a simple "Hello world" page that we'll use |
||||
to make sure our Github Pages page is being |
||||
hosted correctly: |
||||
|
||||
``` |
||||
$ echo '<h2>Hello world!</h2>' > index.html |
||||
$ git add index.html |
||||
$ git commit index.html -m 'Initial commit of gh-pages branch' |
||||
$ git push origin gh-pages |
||||
``` |
||||
|
||||
Now we have our intiial commit on the |
||||
`gh-pages` branch. |
||||
|
||||
|
||||
## Enabling Github Pages |
||||
|
||||
We have one additional step to cover. |
||||
After we create the `gh-pages` branch, |
||||
we want to tell Github Pages that we have |
||||
web content on that branch that we want |
||||
Github to host. |
||||
|
||||
Go to the repository settings, |
||||
and scroll down to the Github Pages |
||||
setting. Select the drop-down option |
||||
to host your Github Pages content |
||||
from the `gh-pages` branch. |
||||
|
||||
Now visit the URL to check out your |
||||
Hello World page: |
||||
|
||||
``` |
||||
https://username.github.io/projectname |
||||
``` |
||||
|
||||
## Adding the real content |
||||
|
||||
We have a hello world page working, |
||||
now let's add the real Pelican content. |
||||
|
||||
Back in the `pelican/` directory, |
||||
clean out the `output/` directory |
||||
(we'll be making everything from |
||||
scratch): |
||||
|
||||
``` |
||||
$ rm -rf output/* |
||||
``` |
||||
|
||||
Don't remove the `output/` directory itself though! |
||||
|
||||
Now make the content: |
||||
|
||||
``` |
||||
$ pelican content |
||||
``` |
||||
|
||||
Now add the content to the `gh-pages` branch |
||||
and push it to Github to deploy it: |
||||
|
||||
``` |
||||
$ cd output/ |
||||
$ git add -A . |
||||
$ git commit -a -m 'Updating site' |
||||
$ git push origin gh-pages |
||||
``` |
||||
|
||||
This will push the new static site (this time with |
||||
the Pelican output) to the `gh-pages` branch on Github. |
||||
Sometimes the site updates really fast (few seconds), |
||||
sometimes it takes longer, but never more than about a minute. |
||||
|
||||
Don't forget to add a link to your new page |
||||
in the repository description (and in your README) |
||||
to make it easier to find! |
||||
|
||||
@ -1,27 +0,0 @@
@@ -1,27 +0,0 @@
|
||||
# Serving your static site |
||||
|
||||
Once you've run the `pelican` command to generate |
||||
your static site, you'll want to see what it looks like. |
||||
To do this, you need to run a simple HTTP server - |
||||
nothing fancy. |
||||
|
||||
(Now you can see the advantage of a static site.) |
||||
|
||||
Run a simple HTTP server with python, which has a |
||||
built-in HTTP server that can be run from the |
||||
command line. |
||||
|
||||
Run the server from the `output/` directory, |
||||
which contains the static content for your site. |
||||
|
||||
``` |
||||
$ cd pelican/output/ |
||||
|
||||
$ python -m http.server # serve content on localhost:8000 |
||||
|
||||
$ python -m http.server 8888 # serve content on localhost:8888 |
||||
``` |
||||
|
||||
Now navigate to `localhost:8000` or `localhost:8888` |
||||
in your browser to view your static site. |
||||
|
||||
@ -1,42 +0,0 @@
@@ -1,42 +0,0 @@
|
||||
# Theming your Pelican site |
||||
|
||||
Custom themes are where Pelican becomes really powerful. |
||||
|
||||
For this tutorial, though, we'll stick to the basics. |
||||
|
||||
See [pelican-themes](https://github.com/getpelican/pelican-themes) |
||||
on Github for a full list of themes. |
||||
|
||||
See [pelicanthemes.com](http://pelicanthemes.com/) |
||||
for a gallery of themes. |
||||
|
||||
## simple-bootstrap theme |
||||
|
||||
For this example, we'll use the [simple-bootstrap](https://github.com/getpelican/pelican-themes/tree/master/simple-bootstrap), |
||||
a simple Bootstrap theme. |
||||
|
||||
To use the simple-bootstrap theme, we have to install it. |
||||
Start by checking out the pelican-themes repo: |
||||
|
||||
``` |
||||
$ git clone --recursive https://github.com/getpelican/pelican-themes |
||||
|
||||
$ cd pelican-themes |
||||
|
||||
$ pelican-themes -i simple-bootstrap |
||||
``` |
||||
|
||||
If you modify or update the theme, you can |
||||
use the `-U` flag (for Update) with `pelican-themes`: |
||||
|
||||
``` |
||||
$ pelican-themes -U simple-bootstrap |
||||
``` |
||||
|
||||
Now you can set the gum theme in your `pelicanconf.py` |
||||
by setting the `THEME` variable: |
||||
|
||||
``` |
||||
THEME="simple-bootstrap" |
||||
``` |
||||
|
||||
@ -1,31 +0,0 @@
@@ -1,31 +0,0 @@
|
||||
# How Do I Pelican? |
||||
|
||||
This is a simple explanation of how to get started |
||||
using Pelican to build a static site. |
||||
It will skip a lot of the details in the |
||||
interest of simplicity. |
||||
|
||||
HTML pages for this tutorial (you are here): [https://pages.charlesreid1.com/how-do-i-pelican/](https://pages.charlesreid1.com/how-do-i-pelican/) |
||||
|
||||
Source code for this tutorial on git.charlesreid1.com: [https://git.charlesreid1.com/charlesreid1/how-do-i-pelican](https://git.charlesreid1.com/charlesreid1/how-do-i-pelican) |
||||
|
||||
Source code for this tutorial on Github: [https://github.com/charlesreid1/how-do-i-pelican](https://github.com/charlesreid1/how-do-i-pelican) |
||||
|
||||
The outline: |
||||
|
||||
* [Before you start - installing Pelican](Before.md) |
||||
* [Getting started with Pelican](Getting.md) |
||||
* [Configuring your Pelican site](Configuring.md) |
||||
* [Theming your Pelican site](Theming.md) |
||||
* [Generating your static site](Generating.md) |
||||
* [Serving your static site](Serving.md) |
||||
* [Adding content](Adding.md) |
||||
* [Hosting on Github Pages](Hosting.md) |
||||
|
||||
Also check out the workflows pages for |
||||
copy-and-paste commands for working with |
||||
your pelican site: |
||||
|
||||
* [Workflow: Initialization of the Github Pages site](#) WorkflowInit.md |
||||
* [Workflow: Update the Github Pages site](#) WorkflowUpdate.md |
||||
|
||||
@ -0,0 +1,484 @@
@@ -0,0 +1,484 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html> |
||||
<html lang="en" class="no-js"> |
||||
<head> |
||||
|
||||
<meta charset="utf-8"> |
||||
<meta name="viewport" content="width=device-width,initial-scale=1"> |
||||
<meta http-equiv="x-ua-compatible" content="ie=edge"> |
||||
|
||||
|
||||
<link rel="canonical" href="https://pages.charlesreid1.com/how-do-i-pelican/"> |
||||
|
||||
|
||||
|
||||
<meta name="lang:clipboard.copy" content="Copy to clipboard"> |
||||
|
||||
<meta name="lang:clipboard.copied" content="Copied to clipboard"> |
||||
|
||||
<meta name="lang:search.language" content="en"> |
||||
|
||||
<meta name="lang:search.pipeline.stopwords" content="True"> |
||||
|
||||
<meta name="lang:search.pipeline.trimmer" content="True"> |
||||
|
||||
<meta name="lang:search.result.none" content="No matching documents"> |
||||
|
||||
<meta name="lang:search.result.one" content="1 matching document"> |
||||
|
||||
<meta name="lang:search.result.other" content="# matching documents"> |
||||
|
||||
<meta name="lang:search.tokenizer" content="[\s\-]+"> |
||||
|
||||
<link rel="shortcut icon" href="."> |
||||
<meta name="generator" content="mkdocs-1.0, mkdocs-material-3.0.3"> |
||||
|
||||
|
||||
|
||||
<title>how do I pelican?</title> |
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="assets/stylesheets/application.451f80e5.css"> |
||||
|
||||
<link rel="stylesheet" href="assets/stylesheets/application-palette.22915126.css"> |
||||
|
||||
|
||||
|
||||
|
||||
<meta name="theme-color" content="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<script src="assets/javascripts/modernizr.1aa3b519.js"></script> |
||||
|
||||
|
||||
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> |
||||
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT Mono","Courier New",Courier,monospace}</style> |
||||
|
||||
|
||||
<link rel="stylesheet" href="assets/fonts/material-icons.css"> |
||||
|
||||
<link rel="stylesheet" href="css/custom.css"> |
||||
|
||||
|
||||
</head> |
||||
|
||||
|
||||
|
||||
<body dir="ltr" data-md-color-primary="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</defs> |
||||
</svg> |
||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
||||
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label> |
||||
|
||||
<a href="#how-do-i-pelican" tabindex="1" class="md-skip"> |
||||
Skip to content |
||||
</a> |
||||
|
||||
|
||||
<header class="md-header" data-md-component="header"> |
||||
<nav class="md-header-nav md-grid"> |
||||
<div class="md-flex"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch"> |
||||
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> |
||||
|
||||
|
||||
<span class="md-header-nav__topic"> |
||||
how do I pelican? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Index |
||||
</span> |
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
|
||||
|
||||
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> |
||||
|
||||
<div class="md-search" data-md-component="search" role="dialog"> |
||||
<label class="md-search__overlay" for="__search"></label> |
||||
<div class="md-search__inner" role="search"> |
||||
<form class="md-search__form" name="search"> |
||||
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> |
||||
<label class="md-icon md-search__icon" for="__search"></label> |
||||
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> |
||||
 |
||||
</button> |
||||
</form> |
||||
<div class="md-search__output"> |
||||
<div class="md-search__scrollwrap" data-md-scrollfix> |
||||
<div class="md-search-result" data-md-component="result"> |
||||
<div class="md-search-result__meta"> |
||||
Type to start searching |
||||
</div> |
||||
<ol class="md-search-result__list"></ol> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
</div> |
||||
|
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<div class="md-header-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
</div> |
||||
|
||||
</div> |
||||
</nav> |
||||
</header> |
||||
|
||||
<div class="md-container"> |
||||
|
||||
|
||||
|
||||
<main class="md-main"> |
||||
<div class="md-main__inner md-grid" data-md-component="container"> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
<nav class="md-nav md-nav--primary" data-md-level="0"> |
||||
<label class="md-nav__title md-nav__title--site" for="__drawer"> |
||||
<a href="https://pages.charlesreid1.com/how-do-i-pelican" title="how do I pelican?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pelican? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pelican" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pelican |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
|
||||
|
||||
<a href="." title="Index" class="md-nav__link md-nav__link--active"> |
||||
Index |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="Before/" title="Before You Start" class="md-nav__link"> |
||||
Before You Start |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="Getting/" title="Getting Started with Pelican" class="md-nav__link"> |
||||
Getting Started with Pelican |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="Configuring/" title="Configuring Your Pelican Site" class="md-nav__link"> |
||||
Configuring Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="Theming/" title="Theming Your Pelican Site" class="md-nav__link"> |
||||
Theming Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="Generating/" title="Generating Your Pelican Site" class="md-nav__link"> |
||||
Generating Your Pelican Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="Serving/" title="Serving Your Static Site" class="md-nav__link"> |
||||
Serving Your Static Site |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="Adding/" title="Adding Content" class="md-nav__link"> |
||||
Adding Content |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="Hosting/" title="Hosting on Github Pages" class="md-nav__link"> |
||||
Hosting on Github Pages |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
</ul> |
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1 id="how-do-i-pelican">How Do I Pelican?<a class="headerlink" href="#how-do-i-pelican" title="Permanent link">¶</a></h1> |
||||
<p>This is a simple explanation of how to get started |
||||
using Pelican to build a static site. |
||||
It will skip a lot of the details in the |
||||
interest of simplicity.</p> |
||||
<p>HTML pages for this tutorial (you are here): <a href="https://pages.charlesreid1.com/how-do-i-pelican/">https://pages.charlesreid1.com/how-do-i-pelican/</a></p> |
||||
<p>Source code for this tutorial on git.charlesreid1.com: <a href="https://git.charlesreid1.com/charlesreid1/how-do-i-pelican">https://git.charlesreid1.com/charlesreid1/how-do-i-pelican</a></p> |
||||
<p>Source code for this tutorial on Github: <a href="https://github.com/charlesreid1/how-do-i-pelican">https://github.com/charlesreid1/how-do-i-pelican</a></p> |
||||
<p>The outline:</p> |
||||
<ul> |
||||
<li><a href="Before/">Before you start - installing Pelican</a></li> |
||||
<li><a href="Getting/">Getting started with Pelican</a></li> |
||||
<li><a href="Configuring/">Configuring your Pelican site</a></li> |
||||
<li><a href="Theming/">Theming your Pelican site</a></li> |
||||
<li><a href="Generating/">Generating your static site</a></li> |
||||
<li><a href="Serving/">Serving your static site</a></li> |
||||
<li><a href="Adding/">Adding content</a></li> |
||||
<li><a href="Hosting/">Hosting on Github Pages</a></li> |
||||
</ul> |
||||
<p>Also check out the workflows pages for |
||||
copy-and-paste commands for working with |
||||
your pelican site:</p> |
||||
<ul> |
||||
<li><a href="#">Workflow: Initialization of the Github Pages site</a> WorkflowInit.md</li> |
||||
<li><a href="#">Workflow: Update the Github Pages site</a> WorkflowUpdate.md</li> |
||||
</ul> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
|
||||
<a href="Before/" title="Before You Start" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Next |
||||
</span> |
||||
Before You Start |
||||
</span> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
||||
</div> |
||||
</a> |
||||
|
||||
</nav> |
||||
</div> |
||||
|
||||
<div class="md-footer-meta md-typeset"> |
||||
<div class="md-footer-meta__inner md-grid"> |
||||
<div class="md-footer-copyright"> |
||||
|
||||
<div class="md-footer-copyright__highlight"> |
||||
Copyright © 2018 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT license</a> |
||||
</div> |
||||
|
||||
powered by |
||||
<a href="https://www.mkdocs.org">MkDocs</a> |
||||
and |
||||
<a href="https://squidfunk.github.io/mkdocs-material/"> |
||||
Material for MkDocs</a> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
</footer> |
||||
|
||||
</div> |
||||
|
||||
<script src="assets/javascripts/application.e72fd936.js"></script> |
||||
|
||||
<script>app.initialize({version:"1.0",url:{base:"."}})</script> |
||||
|
||||
<script src="search/main.js"></script> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
@ -1 +0,0 @@
@@ -1 +0,0 @@
|
||||
Subproject commit b0c6890853aa9138baf5f9749862b927518ab656 |
||||
@ -1,44 +0,0 @@
@@ -1,44 +0,0 @@
|
||||
site_name: how do I pelican? |
||||
site_url: https://pages.charlesreid1.com/how-do-i-pelican |
||||
repo_name: charlesreid1/how-do-i-pelican |
||||
repo_url: https://github.com/charlesreid1/how-do-i-pelican |
||||
edit_uri: "" |
||||
|
||||
copyright: 'Copyright © 2018 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT license</a>' |
||||
|
||||
docs_dir: docs |
||||
site_dir: site |
||||
extra_css: |
||||
- css/custom.css |
||||
theme: |
||||
name: null |
||||
custom_dir: 'mkdocs-material/material' |
||||
palette: |
||||
primary: 'indigo' |
||||
accent: 'indigo' |
||||
logo: |
||||
icon: 'help' |
||||
font: |
||||
text: 'Bitter' |
||||
code: 'PT Mono' |
||||
nav: |
||||
- "Index" : "index.md" |
||||
- "Before You Start" : "Before.md" |
||||
- "Getting Started with Pelican" : "Getting.md" |
||||
- "Configuring Your Pelican Site" : "Configuring.md" |
||||
- "Theming Your Pelican Site" : "Theming.md" |
||||
- "Generating Your Pelican Site" : "Generating.md" |
||||
- "Serving Your Static Site" : "Serving.md" |
||||
- "Adding Content" : "Adding.md" |
||||
- "Hosting on Github Pages" : "Hosting.md" |
||||
|
||||
# Extensions |
||||
markdown_extensions: |
||||
- admonition |
||||
- codehilite: |
||||
guess_lang: false |
||||
- toc: |
||||
permalink: true |
||||
|
||||
|
||||
strict: true |
||||
@ -0,0 +1,94 @@
@@ -0,0 +1,94 @@
|
||||
function getSearchTermFromLocation() { |
||||
var sPageURL = window.location.search.substring(1); |
||||
var sURLVariables = sPageURL.split('&'); |
||||
for (var i = 0; i < sURLVariables.length; i++) { |
||||
var sParameterName = sURLVariables[i].split('='); |
||||
if (sParameterName[0] == 'q') { |
||||
return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20')); |
||||
} |
||||
} |
||||
} |
||||
|
||||
function formatResult (location, title, summary) { |
||||
return '<article><h3><a href="' + base_url + '/' + location + '">'+ title + '</a></h3><p>' + summary +'</p></article>'; |
||||
} |
||||
|
||||
function displayResults (results) { |
||||
var search_results = document.getElementById("mkdocs-search-results"); |
||||
while (search_results.firstChild) { |
||||
search_results.removeChild(search_results.firstChild); |
||||
} |
||||
if (results.length > 0){ |
||||
for (var i=0; i < results.length; i++){ |
||||
var result = results[i]; |
||||
var html = formatResult(result.location, result.title, result.summary); |
||||
search_results.insertAdjacentHTML('beforeend', html); |
||||
} |
||||
} else { |
||||
search_results.insertAdjacentHTML('beforeend', "<p>No results found</p>"); |
||||
} |
||||
} |
||||
|
||||
function doSearch () { |
||||
var query = document.getElementById('mkdocs-search-query').value; |
||||
if (query.length > 2) { |
||||
console.log('Searching with query: ' + query); |
||||
if (!window.Worker) { |
||||
displayResults(search(query)); |
||||
} else { |
||||
searchWorker.postMessage({query: query}); |
||||
} |
||||
} else { |
||||
// Clear results for short queries
|
||||
displayResults([]); |
||||
} |
||||
} |
||||
|
||||
function initSearch () { |
||||
var search_input = document.getElementById('mkdocs-search-query'); |
||||
if (search_input) { |
||||
search_input.addEventListener("keyup", doSearch); |
||||
} |
||||
|
||||
var term = getSearchTermFromLocation(); |
||||
if (term) { |
||||
search_input.value = term; |
||||
doSearch(); |
||||
} |
||||
} |
||||
|
||||
function onWorkerMessage (e) { |
||||
if (e.data.results) { |
||||
var results = e.data.results; |
||||
displayResults(results); |
||||
} |
||||
} |
||||
|
||||
if (!window.Worker) { |
||||
console.log('Web Worker API not supported'); |
||||
// load index in main thread
|
||||
$.getScript(base_url + "/search/worker.js").done(function () { |
||||
console.log('Loaded worker'); |
||||
init(); |
||||
}).fail(function (jqxhr, settings, exception) { |
||||
console.error('Could not load worker.js'); |
||||
}); |
||||
} else { |
||||
// Wrap search in a web worker
|
||||
var searchWorker = new Worker(base_url + "/search/worker.js"); |
||||
searchWorker.postMessage({init: true}); |
||||
searchWorker.onmessage = onWorkerMessage; |
||||
} |
||||
|
||||
$(function() { |
||||
var search_input = document.getElementById('mkdocs-search-query'); |
||||
if (search_input) { |
||||
search_input.addEventListener("keyup", doSearch); |
||||
} |
||||
|
||||
var term = getSearchTermFromLocation(); |
||||
if (term) { |
||||
search_input.value = term; |
||||
doSearch(); |
||||
} |
||||
}); |
||||
File diff suppressed because one or more lines are too long
@ -0,0 +1,127 @@
@@ -0,0 +1,127 @@
|
||||
var base_path = 'function' === typeof importScripts ? '.' : '/search/'; |
||||
var allowSearch = false; |
||||
var index; |
||||
var documents = {}; |
||||
var lang = ['en']; |
||||
var data; |
||||
|
||||
function getScript(script, callback) { |
||||
console.log('Loading script: ' + script); |
||||
$.getScript(base_path + script).done(function () { |
||||
callback(); |
||||
}).fail(function (jqxhr, settings, exception) { |
||||
console.log('Error: ' + exception); |
||||
}); |
||||
} |
||||
|
||||
function getScriptsInOrder(scripts, callback) { |
||||
if (scripts.length === 0) { |
||||
callback(); |
||||
return; |
||||
} |
||||
getScript(scripts[0], function() { |
||||
getScriptsInOrder(scripts.slice(1), callback); |
||||
}); |
||||
} |
||||
|
||||
function loadScripts(urls, callback) { |
||||
if( 'function' === typeof importScripts ) { |
||||
importScripts.apply(null, urls); |
||||
callback(); |
||||
} else { |
||||
getScriptsInOrder(urls, callback); |
||||
} |
||||
} |
||||
|
||||
function onJSONLoaded () { |
||||
data = JSON.parse(this.responseText); |
||||
var scriptsToLoad = ['lunr.js']; |
||||
if (data.config && data.config.lang && data.config.lang.length) { |
||||
lang = data.config.lang; |
||||
} |
||||
if (lang.length > 1 || lang[0] !== "en") { |
||||
scriptsToLoad.push('lunr.stemmer.support.js'); |
||||
if (lang.length > 1) { |
||||
scriptsToLoad.push('lunr.multi.js'); |
||||
} |
||||
for (var i=0; i < lang.length; i++) { |
||||
if (lang[i] != 'en') { |
||||
scriptsToLoad.push(['lunr', lang[i], 'js'].join('.')); |
||||
} |
||||
} |
||||
} |
||||
loadScripts(scriptsToLoad, onScriptsLoaded); |
||||
} |
||||
|
||||
function onScriptsLoaded () { |
||||
console.log('All search scripts loaded, building Lunr index...'); |
||||
if (data.config && data.config.separator && data.config.separator.length) { |
||||
lunr.tokenizer.separator = new RegExp(data.config.separator); |
||||
} |
||||
if (data.index) { |
||||
index = lunr.Index.load(data.index); |
||||
data.docs.forEach(function (doc) { |
||||
documents[doc.location] = doc; |
||||
}); |
||||
console.log('Lunr pre-built index loaded, search ready'); |
||||
} else { |
||||
index = lunr(function () { |
||||
if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) { |
||||
this.use(lunr[lang[0]]); |
||||
} else if (lang.length > 1) { |
||||
this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility
|
||||
} |
||||
this.field('title'); |
||||
this.field('text'); |
||||
this.ref('location'); |
||||
|
||||
for (var i=0; i < data.docs.length; i++) { |
||||
var doc = data.docs[i]; |
||||
this.add(doc); |
||||
documents[doc.location] = doc; |
||||
} |
||||
}); |
||||
console.log('Lunr index built, search ready'); |
||||
} |
||||
allowSearch = true; |
||||
} |
||||
|
||||
function init () { |
||||
var oReq = new XMLHttpRequest(); |
||||
oReq.addEventListener("load", onJSONLoaded); |
||||
var index_path = base_path + '/search_index.json'; |
||||
if( 'function' === typeof importScripts ){ |
||||
index_path = 'search_index.json'; |
||||
} |
||||
oReq.open("GET", index_path); |
||||
oReq.send(); |
||||
} |
||||
|
||||
function search (query) { |
||||
if (!allowSearch) { |
||||
console.error('Assets for search still loading'); |
||||
return; |
||||
} |
||||
|
||||
var resultDocuments = []; |
||||
var results = index.search(query); |
||||
for (var i=0; i < results.length; i++){ |
||||
var result = results[i]; |
||||
doc = documents[result.ref]; |
||||
doc.summary = doc.text.substring(0, 200); |
||||
resultDocuments.push(doc); |
||||
} |
||||
return resultDocuments; |
||||
} |
||||
|
||||
if( 'function' === typeof importScripts ) { |
||||
onmessage = function (e) { |
||||
if (e.data.init) { |
||||
init(); |
||||
} else if (e.data.query) { |
||||
postMessage({ results: search(e.data.query) }); |
||||
} else { |
||||
console.error("Worker - Unrecognized message: " + e); |
||||
} |
||||
}; |
||||
} |
||||
@ -0,0 +1,48 @@
@@ -0,0 +1,48 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pelican/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pelican/Before/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pelican/Getting/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pelican/Configuring/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pelican/Theming/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pelican/Generating/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pelican/Serving/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pelican/Adding/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pelican/Hosting/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
</urlset> |
||||
Binary file not shown.
Loading…
Reference in new issue