Pelican - Revision history

Admin: /* Flags */

2018-01-03T12:43:49Z

Flags

← Older revision		Revision as of 12:43, 3 January 2018
Line 236:		Line 236:
	[[Category:Python]]		[[Category:Python]]
	[[Category:Pelican]]		[[Category:Pelican]]
	~~[[Category:HTML]]~~
	[[Category:Web]]		[[Category:Web]]

Admin at 12:38, 3 January 2018

2018-01-03T12:38:42Z

← Older revision		Revision as of 12:38, 3 January 2018
Line 229:		Line 229:

	</source>		</source>



			=Flags=

			[[Category:Python]]
			[[Category:Pelican]]
			[[Category:HTML]]
			[[Category:Web]]

Admin: /* Static, Non-Blog Sites with Pelican */

2018-01-03T12:37:27Z

Static, Non-Blog Sites with Pelican

← Older revision		Revision as of 12:37, 3 January 2018
Line 161:		Line 161:

	You can also customize the landing page by adding the <code>save_as</code> directive to the top of your Markdown file. If you specify the save_as page as index.html, it will override whatever index.html would have otherwise been made, to give you your own custom landing page in Markdown.		You can also customize the landing page by adding the <code>save_as</code> directive to the top of your Markdown file. If you specify the save_as page as index.html, it will override whatever index.html would have otherwise been made, to give you your own custom landing page in Markdown.

			=Advanced Pelican Configurations=

			You can do quite a bit with the pelican configuration file. The [[Pelican/Advanced]] page contains more examples of configuration files.

	=Configuration=		=Configuration=

Admin: /* Static, Non-Blog Sites with Pelican */

2015-01-13T19:57:29Z

Static, Non-Blog Sites with Pelican

← Older revision		Revision as of 19:57, 13 January 2015
Line 156:		Line 156:
	=Static, Non-Blog Sites with Pelican=		=Static, Non-Blog Sites with Pelican=

	If you want to make a static, non-blog page with Pelican, it is pretty straightforward to do.		If you want to make a static, non-blog page with Pelican, it is pretty straightforward to do.

			I customized my theme's <code>page.html</code> so that I can implement arbitrary variables in my Markdown headers, and use those variables in conditional statements in <code>page.html</code>. This allows for greater flexibility and variety in the page styles I can use.

			You can also customize the landing page by adding the <code>save_as</code> directive to the top of your Markdown file. If you specify the save_as page as index.html, it will override whatever index.html would have otherwise been made, to give you your own custom landing page in Markdown.

	=Configuration=		=Configuration=

Admin: /* Pelican Plugins */

2015-01-13T19:53:39Z

Pelican Plugins

← Older revision		Revision as of 19:53, 13 January 2015
Line 150:		Line 150:

	You can also drop some debug statements into your plugin to see what's going on: put a <code>import pdb; pdb.set_trace()</code> statement into your plugin code.		You can also drop some debug statements into your plugin to see what's going on: put a <code>import pdb; pdb.set_trace()</code> statement into your plugin code.




			=Static, Non-Blog Sites with Pelican=

			If you want to make a static, non-blog page with Pelican, it is pretty straightforward to do.

			=Configuration=

			Here is a typical Pelican configuration file for one of my projects.

			<source lang="python">
			#!/usr/bin/env python
			# -- coding: utf-8 -- #
			from __future__ import unicode_literals

			AUTHOR = u'charlesreid1'
			SITENAME = u'Cyborg Pelican'
			#SITEURL = '/cyborg-pelican'

			PATH = 'content'

			TIMEZONE = 'America/Los_Angeles'

			DEFAULT_LANG = u'en'


			# --------------8<---------------------
			# This is stuff that I have customized


			# Don't try to turn HTML files into pages
			READERS = {'html': None}


			PLUGIN_PATHS = ['/temp/pelican-plugins/']
			PLUGINS = ['liquid_tags','liquid_tags.include_code','liquid_tags.include_html']


			CODE_DIR = 'code'
			BOOKS_DIR = 'books'
			STATIC_PATHS = ['images','code','books']


			THEME = 'cmr-pelican-theme'
			DISPLAY_PAGES_ON_MENU = False

			# dark and pastels.
			#BOOTSWATCH_THEME = 'darkly'

			# dark blue and white
			BOOTSWATCH_THEME = 'flatly'


			# --------------8<---------------------


			# Feed generation is usually not desired when developing
			FEED_ALL_ATOM = None
			CATEGORY_FEED_ATOM = None
			TRANSLATION_FEED_ATOM = None
			AUTHOR_FEED_ATOM = None
			AUTHOR_FEED_RSS = None

			DEFAULT_PAGINATION = False

			# Uncomment following line if you want document-relative URLs when developing
			#RELATIVE_URLS = True

			</source>

Admin: /* Pelican Themes */

2015-01-13T19:51:17Z

Pelican Themes

← Older revision		Revision as of 19:51, 13 January 2015
Line 142:		Line 142:

	You can create your own themes with Pelican, and this is where Pelican becomes a tool for organizing static web content that is a lot like Ruby's Jekyll.		You can create your own themes with Pelican, and this is where Pelican becomes a tool for organizing static web content that is a lot like Ruby's Jekyll.

			=Pelican Plugins=

			==Workflow for Plugin Hacking==

			If you're having trouble while hacking on a Pelican plugin - if your site just doesn't seem to be updating, even after you change the code for a plugin - try deleting the <code>cache/</code> directory. It will force Pelican to re-make ALL HTML pages, not just the ones it thinks have been updated.

			You can also drop some debug statements into your plugin to see what's going on: put a <code>import pdb; pdb.set_trace()</code> statement into your plugin code.

Admin at 01:08, 12 January 2015

2015-01-12T01:08:55Z

← Older revision		Revision as of 01:08, 12 January 2015
Line 138:		Line 138:
	theme		theme
	</pre>		</pre>

			=Pelican Themes=

			You can create your own themes with Pelican, and this is where Pelican becomes a tool for organizing static web content that is a lot like Ruby's Jekyll.

Admin: /* Creating Markdown Content for Pelican Site */

2014-12-21T20:28:05Z

Creating Markdown Content for Pelican Site

← Older revision		Revision as of 20:28, 21 December 2014
Line 91:		Line 91:

	The next steps involve connecting this output folder to the Github branch that is pointed to by our Github Project page's live hosted static content. That way, we can type <code>pelican content</code> to generate content, and then use <code>git push</code> to push the freshly-generated content to the live Github Pages project site.		The next steps involve connecting this output folder to the Github branch that is pointed to by our Github Project page's live hosted static content. That way, we can type <code>pelican content</code> to generate content, and then use <code>git push</code> to push the freshly-generated content to the live Github Pages project site.

			==Connecting Pelican Output to gh-pages Branch==

			The next step will allow you to deploy content directly to the live gh-pages branch, using Pelican.

			In the <code>project/pelican</code> directory (in my case, <code>wordswordswords/pelican</code>):

			<pre>
			$ ls
			Makefile
			cache
			content
			develop_server.sh
			fabfile.py
			output
			pelicanconf.py
			pelicanconf.pyc
			publishconf.py
			</pre>

			We will first remove the <code>output/</code> directory. Then we will check out a copy of the gh-pages branch to the <code>output/</code> directory. Now, when we type <code>pelican content</code>, it will generate the static content directly in the gh-pages branch!

			<pre>
			$ rm -rf output/

			$ git clone -b gh-pages https://github.com/charlesreid1/wordswordswords.git output/
			Cloning into 'output'...
			remote: Counting objects: 40, done.
			remote: Compressing objects: 100% (34/34), done.
			remote: Total 40 (delta 13), reused 29 (delta 3)
			Unpacking objects: 100% (40/40), done.
			Checking connectivity... done

			$ pelican content
			Done: Processed 1 article(s), 0 draft(s) and 0 page(s) in 0.31 seconds.

			$ ls output/
			archives.html
			author
			authors.html
			categories.html
			category
			i-am-a-dummy.html
			index.html
			tags.html
			theme
			</pre>

Admin: /* Using Pelican with Github Project Page */

2014-12-21T20:22:50Z

Using Pelican with Github Project Page

@@ Line 19: / Line 19: @@
 If you want to use pelican to manage a github project page, start by creating a "source code" bundle for your Pelican site in the master branch. This will deploy static content to the gh-pages branch, which is what shows up when you visit <code>http://username.githubpages.io/project-name</code>.
 Start in the master branch of your project. Here, I'll use my Words, Words, Words project as an example.
@@ Line 56: / Line 58: @@
 Done. Your new project is available at /Users/charles/codes/wordswordswords/pelican
 </pre>

Admin at 20:16, 21 December 2014

2014-12-21T20:16:43Z

@@ Line 1: / Line 1: @@
 Begin by using pip to install pelican and markdown:
@@ Line 13: / Line 15: @@
 and the Pelican quickstart guide is here:
 * http://pelican.readthedocs.org/en/3.5.0/quickstart.html