Merge pull request #413 from Pelican-Elegant/fix-add-docs

Fix add docs

.yaspeller.json

@@ -63,6 +63,7 @@
  "FontAwesome",
  "foss",
  "FreeLists",
+ "freelists",
  "fucking",
  "Gan",
  "Garamond",
@@ -105,7 +106,7 @@
  "Lin",
  "linuxabc",
  "MacBook",
- "Mailchimp",
+ "mailchimp",
  "maintainer",
  "maintainers",
  "Makefile",

documentation/content/Elegant - Pelican Theme/elegant-theme.md

@@ -41,66 +41,6 @@ page.
 
 ![Search box]({static}/images/elegant-theme_search-box.png)
 
-## Live Filter for Tags
-
-Elegant is a minimal theme. Instead of creating separate pages for each tag,
-Elegant shows all the tags on a single page. To help visitor find the tags he
-is interested in, Elegant offers live filter.
-
-Go to tags page and type your required tag in "Find a tag" search box. Elegant
-will automatically filter the list.
-
-For example, this is how my tags page looks like
-
-![Tags view
-unfiltered]({static}/images/elegant-theme_tags-live-filter-default.png)
-
-As soon as I type "os", all other tags are filtered out
-
-![Tags view filtered for
-"os"]({static}/images/elegant-theme_tags-live-filter-filtered.png)
-
-With live filter, your reader will have no difficulty in picking up his desired
-tag from the list, even if your site has hundreds of tags.
-
-## All Categories but with zero clutter
-
-Pelican by default creates a separate page for each category. Themes list all
-the articles filed in that category at its page. Elegant takes a different
-approach.
-
-It lists all the categories and their articles on the same page. To reduce
-clutter and utilize space efficiently, each category and its list of articles
-is enclosed in [collapsible
-accordions](http://getbootstrap.com/2.3.2/javascript.html#collapse).
-
-Here is how categories appear collapsed
-
-![Categories accordions
-collapsed]({static}/images/elegant-theme_category-accordions-collapsed.png)
-
-And this is how they appear uncollapsed
-
-![Categories accordions
-uncollapsed]({static}/images/elegant-theme_category-accordions-uncollapsed.png)
-
-Did you notice that categories are listed in ascending alphabetical order and
-articles are sorted by their date in descending order?
-
-## Mailchimp
-
-Mailchimp has become the preferred newsletter service. Elegant shows a form to
-subscribe to your newsletter, above the fold, in the right section of every
-article. Increased visibility is said to increase number of subscribers.
-
-![Mailchimp subscriber
-form]({static}/images/elegant-theme_subscribe-form.png)
-
-You need to put your Mailchimp form action URL in `MAILCHIMP_FORM_ACTION` in
-your configuration file. You can also define `EMAIL_SUBSCRIPTION_LABEL`,
-`EMAIL_FIELD_PLACEHOLDER` and `SUBSCRIBE_BUTTON_TITLE` to customize user
-experience.
-
 ## Custom 404 Page
 
 Elegant has a custom Error 404 page for your readers.

documentation/content/Landing Page/about-me.md

@@ -0,0 +1,45 @@
+---
+Title: Write About Me
+Tags: remarkable, unique, home
+layout: post
+Date: 2019-07-01 01:12
+comments: false
+Slug: write-about-me
+Category: Landing Page
+---
+
+To write about me section, create a page. See [Pelican documentation](http://docs.getpelican.com/en/stable/content.html#pages) on how to create a page.
+
+The slug of the page should be `landing-page-about-hidden` and `status` should be `hidden`. Example,
+
+```yaml
+---
+author: Talha Mansoor
+title: What Is Elegant
+layout: page
+date: 2019-01-14 7:30:47 +0100
+status: hidden
+slug: landing-page-about-hidden
+---
+
+```
+
+The content of this will become your "About me" section, and title will become the heading. You can write content in any markup language, like Markdown, AsciiDoc or reST, as long as Pelican has supports it.
+
+![Home Page Sample]({static}/images/elegant-theme_home-page-features.png)
+
+### Deprecated
+
+!!! Danger "Warning: Legacy Variable"
+
+ `LANDING_PAGE_ABOUT` was available in Elegant V2.5.0. It has since been passed out in favour of `landing-page-about-hidden`. The new method lets you write "About Me" in your favourite markup language.
+
+You can write up your own About me section using `LANDING_PAGE_ABOUT` variable
+in your configuration. It is a dictionary that has two keys `title` and
+`details`.
+
+Value of `title` is displayed in the header of the home page, like
+in the above example it is "I design and build software products for iOS and
+OSX".
+
+`details` is the text that appears under "About me" heading. You can add raw HTML to it.

documentation/content/Landing Page/landing-page.md

@@ -0,0 +1,34 @@
+---
+Title: Unique Home Page Features
+Tags: home, remarkable, unique, guide
+layout: post
+Date: 2019-07-31 01:22
+comments: false
+Slug: unique-home-page-features
+Category: Landing Page
+---
+
+This is the page that visitors see when they open your website. Your chance to
+make a good and lasting first impression. Most sites just display a list of
+recent posts. Elegant goes the extra mile. Check this out
+
+![Home Page Sample]({static}/images/elegant-theme_home-page-features.png)
+
+You can see three features here,
+
+1. Welcome Heading
+1. About me
+1. My Projects
+
+There is a third section below these two sections, "Recent articles".
+
+![Recent Articles Section]({static}/images/elegant-theme_recent-posts.png)
+
+## How to set them up
+
+We have detailed help articles to help you set these sections up
+
+1. [Write Welcome Message]({filename}./welcome.md)
+1. [Write About Me]({filename}./about-me.md)
+1. [Projects List]({filename}./projects-list.md)
+1. [Recent Articles List]({filename}./recent-articles.md)

documentation/content/Landing Page/projects-list.md

@@ -0,0 +1,38 @@
+---
+Title: Projects List
+Tags: remarkable, unique, home
+layout: post
+Date: 2019-07-01 01:12
+comments: false
+Slug: projects-list
+Category: Landing Page
+---
+
+Projects list is read from `PROJECTS`. It is an array of dictionaries. Each
+dictionary has three keys,
+
+1. `name` which will have name of your project,
+1. `url` which will have URL of the project, and
+1. `description` which will have the description of the project.
+
+You can define as many projects as you want. Here
+is an example,
+
+ #!Python
+ PROJECTS = [{
+  'name': 'Logpad + Duration',
+  'url': 'https://github.com/talha131/logpad-plus-duration#logpad--duration',
+  'description': 'Vim plugin to emulate Windows Notepad logging feature,'
+  ' and log duration of each entry'},
+  {'name': 'Elegant Theme for Pelican',
+  'url': 'http://oncrashreboot.com/pelican-elegant',
+  'description': 'A clean and distraction free theme, with search and a'
+  ' lot more unique features, using Jinja2 and Bootstrap'}]
+
+To configure the projects' list title, set `PROJECTS_TITLE` variable in your Pelican configuration. Its default value is "My Projects". For example,
+
+```python
+PROJECTS_TITLE = "Related Projects"
+```
+
+![Home Page Sample]({static}/images/elegant-theme_home-page-features.png)

documentation/content/Landing Page/recent-articles.md

@@ -0,0 +1,15 @@
+---
+Title: Recent Articles List
+Tags: remarkable, unique, home
+layout: post
+Date: 2019-07-01 01:10
+comments: false
+Slug: recent-articles-list
+Category: Landing Page
+---
+
+Recent articles show last `RECENT_ARTICLES_COUNT` whose default value is 10.
+
+It also has a link to "all posts", which takes user to the archives page.
+
+![Recent Articles Section]({static}/images/elegant-theme_recent-posts.png)

documentation/content/Landing Page/welcome.md

@@ -0,0 +1,17 @@
+---
+Title: Write Welcome Message
+Tags: remarkable, unique, home
+layout: post
+Date: 2019-07-01 01:12
+comments: false
+Slug: write-welcome-message
+Category: Landing Page
+---
+
+Define `LANDING_PAGE_TITLE` in your Pelican configuration. It will be displayed as the welcome heading. For example,
+
+```python
+LANDING_PAGE_TITLE = "I design and build software products for iOS and OSX"
+```
+
+![Home Page Sample]({static}/images/elegant-theme_home-page-features.png)

documentation/content/Mailing List/freelists.md

@@ -0,0 +1,27 @@
+---
+Title: Add FreeLists
+Tags: marketing, network, subscriber
+layout: post
+Date: 2018-07-05 23:20
+comments: false
+Slug: add-freelists
+Category: Mailing List
+---
+
+Elegant shows a form to subscribe to your newsletter, above the fold, in the right section of every article.
+
+You need to put your FreeLists name in `FREELISTS_NAME` in your configuration file.
+
+To customize user experience you can also define,
+
+1. `EMAIL_SUBSCRIPTION_LABEL`,
+1. `EMAIL_FIELD_PLACEHOLDER` and
+1. `SUBSCRIBE_BUTTON_TITLE`
+
+!!! Warning
+
+ FreeLists has deprecated the form Elegant used. Due to which,
+ user is redireced to FreeLists [deprecation notice page](https://www.freelists.org/cgi-bin/subscription.cgi).
+ If your `FREELISTS_NAME` is correct then their notice page has a link to their new form.
+
+ Fixing this issue is on our roadmap. You can track it [here](https://github.com/Pelican-Elegant/elegant/issues/412).

documentation/content/Mailing List/mailchimp.md

@@ -0,0 +1,22 @@
+---
+Title: Add Mailchimp
+Tags: marketing, network, subscriber
+layout: post
+Date: 2013-08-27 23:20
+comments: false
+Slug: add-mailchimp
+Category: Mailing List
+---
+
+Elegant shows a form to subscribe to your newsletter, above the fold, in the right section of every article. Increased visibility is said to increase number of subscribers.
+
+![Mailchimp subscriber
+form]({static}/images/elegant-theme_subscribe-form.png)
+
+You need to put your Mailchimp form action URL in `MAILCHIMP_FORM_ACTION` in your configuration file.
+
+To customize user experience you can also define,
+
+1. `EMAIL_SUBSCRIPTION_LABEL`,
+1. `EMAIL_FIELD_PLACEHOLDER` and
+1. `SUBSCRIBE_BUTTON_TITLE`