diff --git a/docs/content.rst b/docs/content.rst index 4b19515f..75534a3b 100644 --- a/docs/content.rst +++ b/docs/content.rst @@ -164,13 +164,13 @@ on all operating systems, including Windows. For example, a Pelican project might be structured like this:: website/ - ├── content - │   ├── category/ - │   │   └── article1.rst - │   ├── article2.md - │ └── pages - │      └── about.md - └── pelican.conf.py + |-- content + |   |-- category/ + |   |   `-- article1.rst + |   |-- article2.md + | `-- pages + |      `-- about.md + `-- pelican.conf.py In this example, ``article1.rst`` could look like this:: @@ -208,12 +208,12 @@ broken links. For example, a project's content directory might be structured like this:: content - ├── images - │   └── han.jpg - ├── pdfs - │   └── menu.pdf - └── pages -    └── test.md + |-- images + |   `-- han.jpg + |-- pdfs + |   `-- menu.pdf + `-- pages +    `-- test.md ``test.md`` would include:: @@ -263,13 +263,13 @@ a directory included in the ``STATIC_PATHS`` setting. For example, a project's content directory might be structured like this:: content - ├── blog - │   ├── icons - │   │   └── icon.png - │   ├── photo.jpg - │   └── testpost.md - └── downloads - └── archive.zip + |-- blog + |   |-- icons + |   |   `-- icon.png + |   |-- photo.jpg + |   `-- testpost.md + `-- downloads + `-- archive.zip ``pelicanconf.py`` would include:: @@ -292,12 +292,12 @@ For example, a project's content directory might be structured like this:: Site generation would then produce an output directory structured like this:: output - └── 2014 - ├── archive.zip - ├── icons - │   └── icon.png - ├── photo.jpg - └── test-post.html + `-- 2014 + |-- archive.zip + |-- icons + |   `-- icon.png + |-- photo.jpg + `-- test-post.html Notice that all the files linked using ``{attach}`` ended up in or beneath the article's output directory. diff --git a/docs/install.rst b/docs/install.rst index 418c8ca6..8f30b140 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -102,14 +102,14 @@ following hierarchy (except for *pages* — shown in parentheses below — which can optionally add yourself if you plan to create non-chronological content):: yourproject/ - ├── content - │   └── (pages) - ├── output - ├── develop_server.sh - ├── fabfile.py - ├── Makefile - ├── pelicanconf.py # Main settings file - └── publishconf.py # Settings to use when ready to publish + |-- content + |   `-- (pages) + |-- output + |-- develop_server.sh + |-- fabfile.py + |-- Makefile + |-- pelicanconf.py # Main settings file + `-- publishconf.py # Settings to use when ready to publish The next step is to begin to adding content to the *content* folder that has been created for you. diff --git a/docs/themes.rst b/docs/themes.rst index 25926893..33b1a0cb 100644 --- a/docs/themes.rst +++ b/docs/themes.rst @@ -22,21 +22,21 @@ Structure To make your own theme, you must follow the following structure:: - ├── static - │   ├── css - │   └── images - └── templates - ├── archives.html // to display archives - ├── period_archives.html // to display time-period archives - ├── article.html // processed for each article - ├── author.html // processed for each author - ├── authors.html // must list all the authors - ├── categories.html // must list all the categories - ├── category.html // processed for each category - ├── index.html // the index (list all the articles) - ├── page.html // processed for each page - ├── tag.html // processed for each tag - └── tags.html // must list all the tags. Can be a tag cloud. + |-- static + |   |-- css + |   `-- images + `-- templates + |-- archives.html // to display archives + |-- period_archives.html // to display time-period archives + |-- article.html // processed for each article + |-- author.html // processed for each author + |-- authors.html // must list all the authors + |-- categories.html // must list all the categories + |-- category.html // processed for each category + |-- index.html // the index (list all the articles) + |-- page.html // processed for each page + |-- tag.html // processed for each tag + `-- tags.html // must list all the tags. Can be a tag cloud. * `static` contains all the static assets, which will be copied to the output `theme` folder. The above filesystem layout includes CSS and image folders,