Changeset - a2982e3368aa
[Not reviewed]
0 1 0
Michael Guravage (guravage) - 11 years ago 2015-01-08 18:19:19
m.a.guravage@cwi.nl
Removed bogus blank lines from README.txt
1 file changed with 0 insertions and 8 deletions:
0 comments (0 inline, 0 general)
README.txt
Show inline comments
 
@@ -34,44 +34,40 @@ If you plan on using Markdown as a markup format, you’ll need to install the M
 

	
 
Typographical enhancements can be enabled in your settings file, but
 
first the requisite Typogrify library must be installed::
 

	
 
    pip install typogrify
 

	
 

	
 
Installing Pelican project template
 
-----------------------------------
 

	
 
To kick start your website development we have created a
 
pre-fabricated Pelican theme and project template with example
 
content. While you can install the template anywhere you like, for
 
this example, please clone the cwi-pelican-template in the root of
 
your Pelican virtual environment. Don't forget to use your own
 
username in the url::
 

	
 
    git clone https://<username>@scm.cwi.nl/ITF/cwi-pelican-template cwi
 

	
 

	
 
Installing the Pelican CWI theme
 
--------------------------------
 

	
 
The cwi project template uses a corresponding CWI theme, but it must
 
be installed before Pelican can use it::
 

	
 
    pelican-theme --symlink ${PWD}/cwi/theme/cwi
 

	
 

	
 
Usage
 
=====
 

	
 
To generate html output, go to the project directory and invoke Pelican via make::
 

	
 
    cd cwi/projects/cwi
 
    make html
 

	
 

	
 
Previewing
 
----------
 

	
 
Pelican has its own built-in server. You can invoke it with make; or
 
you can regenerate the HTML and serve it in one command::
 

	
 
@@ -152,13 +148,12 @@ configuration files: pelicanconf.py and publishconf.py::
 
    │   │   │   │   └──  news.md
 
    │   │   │   ├──  private
 
    │   │   │   │   └──  private.md
 
    │   │   │   └──  static
 
    │   │   │       └──  annual-report.pdf
 

	
 

	
 
CWI Theme hierarchy
 
-------------------
 

	
 
You need not change anything here. But if the need arises, here is
 
where you will affect your changes to the theme::
 

	
 
@@ -214,14 +209,12 @@ where you will affect your changes to the theme::
 
        │       ├──  tag.html
 
        │       ├──  taglist.html
 
        │       ├──  tags.html
 
        │       ├──  translations.html
 
        │       └──  twitter.html
 

	
 

	
 

	
 
Output hierarchy structure
 
--------------------------
 

	
 
Here is the structure of the HTML Pelican generates::
 

	
 
    ├──  projects
 
@@ -283,13 +276,12 @@ Here is the structure of the HTML Pelican generates::
 
    │   │   │               ├──  speakerdeck.png
 
    │   │   │               ├──  stackoverflow.png
 
    │   │   │               ├──  twitter.png
 
    │   │   │               ├──  vimeo.png
 
    │   │   │               └──  youtube.png
 

	
 

	
 
Pelican Documentation
 
=====================
 

	
 
You will find answers to all your Pelican questions in the Pelican
 
documentation. You will find the Pelican documentation at
 
com/en/3.5.0.
0 comments (0 inline, 0 general)