diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33c536a3..f89bafd7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,111 +1,3 @@ -# Where do I start? +See our documentation at following link -Developing Elegant is a community effort, so you are very welcome to help develop it further into the most elegant theme out there. - -The main repository of Elegant is on [GitHub][elegant], which you may fork and then submit pull requests to, in order for them to be merged. - -If you found any issues, or have ideas how to improve the theme, please submit an [issue]. - -Also see issues tagged as [Pull Request Welcome](https://github.com/Pelican-Elegant/elegant/labels/pull%20request%20welcome) – these are issues that are not directly on our roadmap, but if you have time to contribute, we would be very glad to review and accept your pull request. - -If you want to contribute to documentation instead, do so in the [documentation repository][documentation]. Some easy tasks to tackle there are tagged as [Good First Issue](https://github.com/Pelican-Elegant/documentation/labels/good%20first%20issue) - -# Contributing Code - -1. Create a new git branch specific to your changes, instead of making your commits in the master branch. For example, create a branch `fix-issue-119` and add commits to it that fix “issue 119”. -2. Update the [CHANGELOG] -3. Create pull request from your fix branch, say `fix-issue-119`, against `next` branch of Elegant. (We use `master` branch to make new releases. `next` is used for development.) -4. Each pull request should only have a single feature or fix. Do not add multiple features or bug fixes to the same pull request. -5. Squash your commits to reduce noise from commit history. Use your better judgement to decide which commits should stay in the commit history, or consult project maintainers if confused. -6. Have (at least) one other active contributor review your code. -7. Once at least one code reviewer has approved it, it will can be merged. - -## Git Tips for Newcomers - -Here are some tips on how to make your life with Git easier when contributing. - -### How To Set Up Your Git - -1. Create a fork of the [Elegant repository][elegant] by clicking on the “Fork” button. -2. Clone your fork to your computer by clicking on the “Clone or download” button and following the instructions there. -3. When in the Git repository of your fork, run the following command to set the main repository as the upstream: `git remote add upstream https://github.com/Pelican-Elegant/pelican-elegant.git` - -### Updating/Rebasing to Upstream - -Occasionally – often before a pull request is able to be merged – you will need to update your own (fork) repository to the upstream (i.e. [Elegant][elegant]) development (i.e. `next`) branch. This can be done as follows: - -1. `git fetch upstream next` -2. `git rebase upstream/next` - -### Squash Commits & More Complex Rebasing - -When creating a pull request in GitHub, you have the option to squash all commits, but sometimes you need to fix either the mess you made or some clashes that prevent a merge of the two branches. - -In both cases, the following command is your Swiss-army knife: - -`git rebase --interactive upstream/master` - -For more on the interactive rebase command of Git, see [its official documentation][git_rebase]. - -[git_rebase]: https://git-scm.com/docs/user-manual#interactive-rebase - -# New Features and Styles - -If you plan to add new features to the theme, please make sure that: - -- you set sensible defaults so the theme works out of the box, without forcing the user to set any variable -- your changes do not negatively effect readability and reading experience -- your changes do not cause distraction for the reader -- any bigger features should go through the voting process (see below) - -# Code style - -Please make sure to follow the code style of the existing code base. - -Specifically: - -## Code/Template Formatting Rules - -- use single (`''`) rather than double (`""`) quotation marks for Jinja strings -- in Jinja print statements, surround the variable with spaces inside curly braces – for example: `{{ foo.bar }}` -- use double (`""`) quotation marks around HTML attributes -- end files with a newline - -## CSS Formatting Rules - -- font name’s first letter should be capital -- add a space after comma -- declarations should be sorted alphabetically -- use a single space between the last selector and the opening brace that begins the declaration block -- group together related classes and identities -- add a space after colon -- remove leading 0s -- remove unit specification after 0 values -- use three-digit Hex notation for colors wherever possible -- use hyphen `-` instead of underscore `_` in class and identity names - -Refer to [Google's HTML/CSS Style Guide][google_style_guide] for all other formatting rules. - -# Voting Process - -Any new features, bigger changes, decisions on what should constitute the next milestone or wider goals etc. should go through a vote, as follows. - -1. Open a new issue to describe it and to kick-start a discussion. -1. As soon as a suggestion (or several) are set in place, set a deadline, no shorter than 10 days. Also at this stage tag the issue with the “vote” label. -1. People can vote with the :+1: and :-1: emoji on individual suggestions. Anyone may cast votes for as many suggestions as they want. -1. At the end of the deadline, the suggestion with most votes (= № of :+1: - № of :-1:) is taken. - -# Licensing (Inbound=Outbound) - -All contributions will be understood to be made under the same (inbound) license as the main (outbound) license of the repository it is being contributed to – so [MIT License][] for all [code/theme][elegant] contributions, and [CC-BY-SA-3.0][] for all [documentation][] contributions. - -If you are contributing code that is not yours, make sure to indicate where you got the code from (and who the author/copyright holder is) and what license you got it under. - -[cc-by-sa-3.0]: https://spdx.org/licenses/CC-BY-SA-3.0.html -[changelog]: https://github.com/Pelican-Elegant/elegant/blob/master/CHANGELOG.md -[contributing]: ./CONTRIBUTING.md -[documentation]: https://github.com/Pelican-Elegant/documentation -[elegant]: https://github.com/Pelican-Elegant/elegant -[google_style_guide]: https://google.github.io/styleguide/htmlcssguide.html -[issue]: https://github.com/Pelican-Elegant/elegant/issues/ -[mit license]: https://spdx.org/licenses/MIT.html +http://localhost:9000/categories.html#contributing-ref diff --git a/documentation/content/Analytics/google-analytics.md b/documentation/content/Analytics/google-analytics.md index 3e339372..442828af 100644 --- a/documentation/content/Analytics/google-analytics.md +++ b/documentation/content/Analytics/google-analytics.md @@ -1,3 +1,4 @@ +--- Title: How to use Google Analytics Tags: web-analytics Category: Analytics @@ -5,9 +6,10 @@ Date: 2013-11-11 23:05 Slug: how-to-use-google-analytics Disqus_identifier: cf14ac5-how-to-use-google-analytics Subtitle: -Summary: Elegant Pelican theme supports Google Analytics out of -the box. This articles describes how to set it up. +Summary: Elegant Pelican theme supports Google Analytics out of the box. This articles describes how to set it up. Keywords: +authors: Talha Mansoor +--- Elegant supports the popular web tracking service, [Google Analytics](http://www.google.com/analytics/). diff --git a/documentation/content/Analytics/stat-counter.md b/documentation/content/Analytics/stat-counter.md index bce0ff48..6475ec70 100644 --- a/documentation/content/Analytics/stat-counter.md +++ b/documentation/content/Analytics/stat-counter.md @@ -1,3 +1,4 @@ +--- Title: How to use StatCounter Tags: web-analytics Category: Analytics @@ -5,9 +6,10 @@ Date: 2013-11-11 23:05 Slug: how-to-use-statcounter-analytics Disqus_identifier: 4kv80xq-how-to-use-statcounter Subtitle: -Summary: Elegant Pelican theme supports StatCounter out of -the box. This articles describes how to set them up. +Summary: Elegant Pelican theme supports StatCounter out of the box. This articles describes how to set them up. Keywords: +authors: Talha Mansoor +--- Elegant has support for popular web tracking service, [StatCounter](http://statcounter.com/). diff --git a/documentation/content/Appearance and Style/article-subtitle.md b/documentation/content/Appearance and Style/article-subtitle.md index 71d309aa..30868df2 100644 --- a/documentation/content/Appearance and Style/article-subtitle.md +++ b/documentation/content/Appearance and Style/article-subtitle.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: article-subtitle Category: Appearance & Style +authors: Talha Mansoor --- Pelican lets you define title of your article in the meta data. Elegant adds diff --git a/documentation/content/Appearance and Style/modified-date.md b/documentation/content/Appearance and Style/modified-date.md index 96be6ec1..fa5b3fba 100644 --- a/documentation/content/Appearance and Style/modified-date.md +++ b/documentation/content/Appearance and Style/modified-date.md @@ -1,3 +1,4 @@ +--- Title: How does modified metadata works Tags: web-design, meta-data, date Category: Appearance & Style @@ -7,6 +8,8 @@ Disqus_identifier: q4nz2k0-how-does-modified-metadata-works Subtitle: Summary: Use modified metadata to show the date at which you last updated the article Keywords: +authors: Talha Mansoor +--- You need to update your articles time and again. Sometimes it makes sense to display the date when you updated the article. You can show the last updated diff --git a/documentation/content/Appearance and Style/page-title.md b/documentation/content/Appearance and Style/page-title.md index ce8e9eef..ef6b2bf2 100644 --- a/documentation/content/Appearance and Style/page-title.md +++ b/documentation/content/Appearance and Style/page-title.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: page-title Category: Appearance & Style +authors: Talha Mansoor --- Elegant follows following format for the `` tag diff --git a/documentation/content/Appearance and Style/table-of-contents.md b/documentation/content/Appearance and Style/table-of-contents.md index dd7a5a1d..2a677d93 100644 --- a/documentation/content/Appearance and Style/table-of-contents.md +++ b/documentation/content/Appearance and Style/table-of-contents.md @@ -1,3 +1,4 @@ +--- Title: How Elegant displays Table of Contents Tags: reST, markdown, navigation, web-design, contents Category: Appearance & Style @@ -7,6 +8,8 @@ Disqus_identifier: lm95rjd-how-elegant-displays-table-of-contents Subtitle: Summary: Elegant shows Table of Contents, if available, non intrusively to give a clean reading experience to the visitor Keywords: +authors: Talha Mansoor +--- [TOC] diff --git a/documentation/content/Appearance and Style/web-safe-fonts.md b/documentation/content/Appearance and Style/web-safe-fonts.md index c74db7d1..2a082287 100644 --- a/documentation/content/Appearance and Style/web-safe-fonts.md +++ b/documentation/content/Appearance and Style/web-safe-fonts.md @@ -1,8 +1,11 @@ +--- Title: Web Safe Fonts Tags: web-design Category: Appearance & Style Date: 2014-04-22 16:23 Slug: web-safe-fonts +authors: Talha Mansoor +--- Elegant uses commonly available typefaces in every style rule. It has a list of closely matching fonts in the fallback list. diff --git a/documentation/content/Code Snippets/code-style.md b/documentation/content/Code Snippets/code-style.md index e98b8bf7..c87ea2d4 100644 --- a/documentation/content/Code Snippets/code-style.md +++ b/documentation/content/Code Snippets/code-style.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: code-snippets-theme Category: Code Snippets +authors: Talha Mansoor --- Elegant uses [Solarized](http://ethanschoonover.com/solarized) theme for syntax diff --git a/documentation/content/Code Snippets/custome-syntax-theme.md b/documentation/content/Code Snippets/custome-syntax-theme.md new file mode 100644 index 00000000..0887e94c --- /dev/null +++ b/documentation/content/Code Snippets/custome-syntax-theme.md @@ -0,0 +1,22 @@ +--- +Title: Change Syntax Highlight Theme +Tags: unique +Date: 2019-07-03 20:18 +Slug: change-syntax-highlight-theme +Category: Code Snippets +authors: Talha Mansoor +--- + +Elegant uses [Solarized theme](http://ethanschoonover.com/solarized) for syntax +highlighting. To replace it, copy contents of your preferred theme's CSS style +sheet into `custom.css`. + +Alternatively, you can replace contents of `pygments.css` with your theme's +style sheet. + +If you feel like experimenting with different themes then [this +repository](https://github.com/uraimo/pygments-vimstyles) has Pygments CSS of +Vim themes. [This one](https://github.com/richleland/pygments-css) has Pygments +CSS of built-in styles. Do not forget to change `.codehilite` CSS class +identifier to `.highlight`. Code blocks in Pelican generated HTML use +`.highlight` class. diff --git a/documentation/content/Code Snippets/line-numbers-code-snippet.md b/documentation/content/Code Snippets/line-numbers-code-snippet.md index a4485898..94fdb9a2 100644 --- a/documentation/content/Code Snippets/line-numbers-code-snippet.md +++ b/documentation/content/Code Snippets/line-numbers-code-snippet.md @@ -1,3 +1,4 @@ +--- Title: Display Line Numbers in Code Snippets Tags: markdown, reST, code-snippets, gist Category: Code Snippets @@ -6,6 +7,8 @@ Slug: display-line-numbers-in-code-snippets Subtitle: Summary: reStructuredText and Markdown have directives that generate line numbers for code blocks. Use them to display line numbers in code snippets. Keywords: codehilite, python-markdown +authors: Talha Mansoor +--- reStructuredText and Markdown have directives that generate line numbers for code snippets. Install [Pygments](http://pygments.org/) to use these directives. diff --git a/documentation/content/Comments/collapsible-comments.md b/documentation/content/Comments/collapsible-comments.md index 66d46995..19f2609b 100644 --- a/documentation/content/Comments/collapsible-comments.md +++ b/documentation/content/Comments/collapsible-comments.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: collapsible-comments Category: Commenting +authors: Talha Mansoor --- Readers use scroll bar to track their progress when reading inside their diff --git a/documentation/content/Comments/comment-id.md b/documentation/content/Comments/comment-id.md index 2b85cd22..06e860fe 100644 --- a/documentation/content/Comments/comment-id.md +++ b/documentation/content/Comments/comment-id.md @@ -6,6 +6,7 @@ date: 2019-06-30 22:29 comments: false Slug: comments-thread-id Category: Commenting +authors: Talha Mansoor --- Most Pelican themes pass article URL to Disqus as the [Disqus diff --git a/documentation/content/Comments/disable-comments.md b/documentation/content/Comments/disable-comments.md index c2150287..3aef9ede 100644 --- a/documentation/content/Comments/disable-comments.md +++ b/documentation/content/Comments/disable-comments.md @@ -6,6 +6,7 @@ date: 2019-01-12 16:29 comments: false Slug: disable-comments-per-article Category: Commenting +authors: Talha Mansoor --- If you remove your comment service configuration, say you set `DISQUS_SITENAME` to empty string, then comments will disappear from all the articles. diff --git a/documentation/content/Comments/disqus-comments.md b/documentation/content/Comments/disqus-comments.md index ef4f1e0d..53dd934b 100644 --- a/documentation/content/Comments/disqus-comments.md +++ b/documentation/content/Comments/disqus-comments.md @@ -1,3 +1,4 @@ +--- Title: Enable Disqus Comments Tags: interaction Category: Commenting @@ -6,6 +7,8 @@ Slug: enable-disqus-comments comment_id: 9jgwmy8-how-to-use-disqus-comments-elegantly Subtitle: Summary: Elegant offers Disqus comments out of the box with few unique features +authors: Talha Mansoor +--- You can use Disqus for comments. You have to set `DISQUS_SITENAME` to Disqus site name identifier in configuration to enable comments. diff --git a/documentation/content/Comments/invite-comments.md b/documentation/content/Comments/invite-comments.md index 399346bc..787e72e1 100644 --- a/documentation/content/Comments/invite-comments.md +++ b/documentation/content/Comments/invite-comments.md @@ -6,6 +6,7 @@ Date: 2014-04-21 16:39 comments: false Slug: invite-visitors-comment Category: Commenting +authors: Talha Mansoor --- Instead of just throwing in comments form at the end of every article, Elegant diff --git a/documentation/content/Contributing/adding-new-features.md b/documentation/content/Contributing/adding-new-features.md new file mode 100644 index 00000000..9ba88fe5 --- /dev/null +++ b/documentation/content/Contributing/adding-new-features.md @@ -0,0 +1,13 @@ +--- +Title: Contributing New Features +Date: 2019-07-03 22:17 +Slug: contributing-new-features +Category: Contributing +authors: Talha Mansoor +--- + +If you plan to add new features to the theme, please make sure that: + +- you set sensible defaults so the theme works out of the box, without forcing the user to set any variable +- your changes do not negatively effect readability and reading experience +- your changes do not cause distraction for the reader diff --git a/documentation/content/Contributing/beginners-guide.md b/documentation/content/Contributing/beginners-guide.md new file mode 100644 index 00000000..0a2b9999 --- /dev/null +++ b/documentation/content/Contributing/beginners-guide.md @@ -0,0 +1,34 @@ +--- +Title: Git Tips for Beginners +Date: 2019-07-03 21:57 +Slug: git-tips-for-beginners +Category: Contributing +--- + +Here are some tips on how to make your life with Git easier when contributing. + +## How To Set Up Your Git + +1. Create a fork of the [Elegant repository][elegant] by clicking on the “Fork” button. +2. Clone your fork to your computer by clicking on the “Clone or download” button and following the instructions there. +3. When in the Git repository of your fork, run the following command to set the main repository as the upstream: `git remote add upstream https://github.com/Pelican-Elegant/pelican-elegant.git` + +## Updating/Rebasing to Upstream + +Occasionally – often before a pull request is able to be merged – you will need to update your own (fork) repository to the upstream (i.e. [Elegant][elegant]) development (i.e. `next`) branch. This can be done as follows: + +1. `git fetch upstream next` +2. `git rebase upstream/next` + +## Squash Commits & More Complex Rebasing + +When creating a pull request in GitHub, you have the option to squash all commits, but sometimes you need to fix either the mess you made or some clashes that prevent a merge of the two branches. + +In both cases, the following command is your Swiss-army knife: + +`git rebase --interactive upstream/master` + +For more on the interactive rebase command of Git, see [its official documentation][git_rebase]. + +[git_rebase]: https://git-scm.com/docs/user-manual#interactive-rebase +[elegant]: https://github.com/Pelican-Elegant/elegant diff --git a/documentation/content/Announcements/community-driven-project.md b/documentation/content/Contributing/community-driven-project.md similarity index 99% rename from documentation/content/Announcements/community-driven-project.md rename to documentation/content/Contributing/community-driven-project.md index b287e30d..998255bf 100644 --- a/documentation/content/Announcements/community-driven-project.md +++ b/documentation/content/Contributing/community-driven-project.md @@ -1,7 +1,7 @@ --- Title: Elegant grows into a community-led project Tags: project-management -Category: Announcements +Category: Contributing Date: 2019-01-05 19:40 Slug: community-led-project Subtitle: The beginning of a beautiful friendship diff --git a/documentation/content/Contributing/contributing-license.md b/documentation/content/Contributing/contributing-license.md new file mode 100644 index 00000000..26971d18 --- /dev/null +++ b/documentation/content/Contributing/contributing-license.md @@ -0,0 +1,15 @@ +--- +Title: Contributions Licesne +Date: 2019-07-03 22:07 +Slug: contribution-license +Category: Contributing +--- + +All contributions will be understood to be made under the same (inbound) license as the main (outbound) license of the repository it is being contributed to – so [MIT License][] for all code/theme contributions, and [CC-BY-SA-3.0][] for all documentation contributions. + +If you are contributing code that is not yours, make sure to indicate where you got the code from (and who the author/copyright holder is) and what license you got it under. + +[cc-by-sa-3.0]: https://spdx.org/licenses/CC-BY-SA-3.0.html +[documentation]: https://github.com/Pelican-Elegant/documentation +[elegant]: https://github.com/Pelican-Elegant/elegant +[mit license]: https://spdx.org/licenses/MIT.html diff --git a/documentation/content/Contributing/inviation.md b/documentation/content/Contributing/inviation.md new file mode 100644 index 00000000..d36bd858 --- /dev/null +++ b/documentation/content/Contributing/inviation.md @@ -0,0 +1,22 @@ +--- +Title: Invitation to participate +Date: 2019-07-03 20:07 +Slug: invitation-to-participate +Category: Contributing +--- + +Our brand new documentation website [elegant.onCrashReboot.com][elegant-home] is a great demo for the theme. + +If you like the theme and would like to contribute to Elegant, you are most welcome to do so. Even though Pelican is written in Python, no coding skills are needed to help out with Elegant, as themes consist mostly of [Jinja][] templates, CSS and HTML. It is honestly very easily to get into. + +If you want to help out, but have no idea where to start, we keep a list of [low-priority features that are just waiting for you to pick up][pr_welcome]. + +Another way to contribute is to help with the [documentation][docs]. We are keeping a list of [good first issues][docs_first] for newbies to get involved – these are easy to tackle, but in no way less helpful. + +And, of course, reporting bugs and filing feature requests to further improve Elegant (and its documentation), is also welcome. + +[jinja]: http://jinja.pocoo.org/ +[pr_welcome]: https://github.com/Pelican-Elegant/elegant/labels/pull%20request%20welcome +[docs]: https://github.com/Pelican-Elegant/elegant/tree/master/documentation +[docs_first]: https://github.com/Pelican-Elegant/elegant/issues?q=is%3Aopen+is%3Aissue+label%3A%22project+documentation%22 +[elegant-home]: https://elegant.oncrashreboot.com diff --git a/documentation/content/Contributing/jinja-style.md b/documentation/content/Contributing/jinja-style.md new file mode 100644 index 00000000..e9923a71 --- /dev/null +++ b/documentation/content/Contributing/jinja-style.md @@ -0,0 +1,16 @@ +--- +Title: Code Style for Jinja2 +Date: 2019-07-03 22:17 +Slug: code-style-for-jinja2 +Category: Contributing +authors: Talha Mansoor +--- + +Please make sure to follow the code style of the existing code base. + +Specifically: + +- use single (`''`) rather than double (`""`) quotation marks for Jinja strings +- in Jinja print statements, surround the variable with spaces inside curly braces – for example: `{{ foo.bar }}` +- use double (`""`) quotation marks around HTML attributes +- end files with a newline diff --git a/documentation/content/Elegant - Pelican Theme/configuration-variables.md b/documentation/content/Elegant - Pelican Theme/configuration-variables.md deleted file mode 100644 index cb111f7e..00000000 --- a/documentation/content/Elegant - Pelican Theme/configuration-variables.md +++ /dev/null @@ -1,103 +0,0 @@ -Title: Configuration Variables and Metadata List -Tags: pelican-theme, config -Category: Elegant - Pelican Theme -Date: 2014-04-23 18:25 -Slug: configuration-variables-and-metadata-list -Disqus_identifier: dexlwa8-configuration-variables-and-metadata-list -Subtitle: -Summary: List of all the configuration variables and metadata that you can use with Elegant -Keywords: - -[TOC] - -## Pelican Configuration - -These are the settings that will help you get the most out of Elegant - - #!python - TAG_SAVE_AS = '' - AUTHOR_SAVE_AS = '' - CATEGORY_SAVE_AS = '' - STATIC_PATHS = ['theme/images', 'images'] - PLUGINS = ['sitemap', 'extract_toc', 'tipue_search', - 'neighbors', 'assets', 'share_post'] - MD_EXTENSIONS = ['codehilite(css_class=highlight)', 'extra', - 'headerid', 'toc(permalink=true)'] - DIRECT_TEMPLATES = (('index', 'tags', 'categories','archives', 'search', '404')) - -## Configuration Variables - -These are the optional configuration variables that you can define - -1. `PROJECTS` used for [Projects - feature](elegant-best-pelican-theme-features#projects) - on the landing page -1. `USE_SHORTCUT_ICONS` used for [shortcut icons like favicon, Opera Speed - Dial](how-to-set-shortcut-icons) -1. `SITE_LICENSE` used to add [site - license](few-more-features-of-elegant#add-license-to-your-site) -1. `SITE_SUBTITLE` used to add [site subtitle in the - footer](few-more-features-of-elegant#site-subtitle) -1. `COMMENTS_INTRO` used with - [comments](how-to-use-disqus-comments-elegantly#invite-visitors-to-comment) -1. `SITE_DESCRIPTION` used for [Search Engine - Optimization](search-engine-and-social-media-optimization#search-engine-optimization-seo) -1. `SOCIAL_PROFILE_LABEL` used with [social media profiles - widget](how-to-display-your-social-media-profiles) -1. `RECENT_ARTICLES_COUNT` see the post [Recent - Articles](elegant-best-pelican-theme-features#recent-articles) - -These are the variables used for [Mailchimp subscriber -form](elegant-best-pelican-theme-features#mailchimp) in the sidebar, - -1. `MAILCHIMP_FORM_ACTION` is mandatory. Set it to your Mailchimp form action - URL -1. `SUBSCRIBE_BUTTON_TITLE` -1. `EMAIL_FIELD_PLACEHOLDER` -1. `EMAIL_SUBSCRIPTION_LABEL` - -These are the variables used with different Pelican plugins, - -1. `SERIES_TITLE` used with [`multi_part` plugin](how-to-use-multi-part-plugin) -1. `SHARE_POST_INTRO` used with [`share_post` - plugin](how-to-use-social-sharing-plugin) -1. `RELATED_POSTS_LABEL` used with [`related_posts` - plugin](https://github.com/getpelican/pelican-plugins/tree/master/related_posts) - -These are the variables used for [Social Media -Optimization](search-engine-and-social-media-optimization#social-media-optimization-smo), - -1. `FEATURED_IMAGE` -1. `TWITTER_USERNAME` - -This site uses Elegant theme. You -can view its configuration files at -[Github](https://github.com/Pelican-Elegant/documentation) for inspiration. - -## Metadata - -Pelican uses [file -metadata](http://docs.getpelican.com/en/latest/getting_started.html#file-metadata) -from your articles and pages text files to get information about your posts, -like tags, authors etc. - -On top of _"official"_ metadata, Elegant uses some optional metadata that you -can use in your articles and pages. - -1. `summary` used for [Search Engine - Optimization](search-engine-and-social-media-optimization#search-engine-optimization-seo) -1. `subtitle` used to set [article - subtitle](elegant-best-pelican-theme-features#article-subtitle) -1. `keywords` used for [Search Engine - Optimization](search-engine-and-social-media-optimization#search-engine-optimization-seo) -1. `modified` used to set [last updated time](how-does-modified-metadata-works) - of the article -1. `series_title` used with [`multi_part` plugin](how-to-use-multi-part-plugin) -1. `featured_image` used for [Social Media - Optimization](search-engine-and-social-media-optimization#social-media-optimization-smo) -1. `comments_intro` used with - [comments](how-to-use-disqus-comments-elegantly#invite-visitors-to-comment) -1. `share_post_intro` used with [`share_post` - plugin](how-to-use-social-sharing-plugin) -1. `disqus_identifier` used with - [comments](how-to-use-disqus-comments-elegantly#disqus-thread-id) diff --git a/documentation/content/Elegant - Pelican Theme/customize-elegant.md b/documentation/content/Elegant - Pelican Theme/customize-elegant.md deleted file mode 100644 index 34e35be0..00000000 --- a/documentation/content/Elegant - Pelican Theme/customize-elegant.md +++ /dev/null @@ -1,123 +0,0 @@ -Title: How to Customize Elegant -Tags: pelican-theme, config -Category: Elegant - Pelican Theme -Date: 2014-03-24 14:05 -Slug: how-to-customize-elegant -Disqus_identifier: ale31i7-how-to-customize-elegant -Subtitle: -Summary: You can customize every aspect of Elegant without touching the source code -Keywords: - -[TOC] - -You can change Elegant's look, color palette, font, size, and even labels used -for widgets, sections and plugins. - -Elegant is best maintained when you treat it as a separate resource in your -project. Do not edit template files, JavaScript code and style sheets. This -practice will make upgrading Elegant fuss free process. - -Instead use following recommended ways. - -# Customize Style - -To customize Elegant's visual style, use -[`custom.css`](https://github.com/Pelican-Elegant/elegant/blob/master/static/css/custom.css). -You can override Elegant's visual style like font, color, spacing etc using -this sheet. This empty style sheet is present at following path in your Elegant -folder, - - :::bash - static/css/custom.css - -Find the code of the element you want to customize in -[`elegant.css`](https://github.com/Pelican-Elegant/elegant/blob/master/static/css/elegant.css). -Copy the element's selector and styles, and paste it in `custom.css`. Edit this -CSS code and customize it to your liking. - -Your customizations will override whatever rules are defined in `elegant.css`. - -Let's take a look how you can change the style of hyperlinks in an article. -Following is the relevant code, - - :::css - article p:not(#list-of-translations):not(#post-share-links) a, - article ol a, - article div.article-content ul:not(.articles-timeline):not(.related-posts-list) a { - - border-bottom: thin dashed #A9A9A9; - color: #000; - } - -Copy and paste it in `custom.css`. Change color to red for example, - - :::css - article p:not(#list-of-translations):not(#post-share-links) a, - article ol a, - article div.article-content ul:not(.articles-timeline):not(.related-posts-list) a { - - border-bottom: thin dashed #A9A9A9; - color: red; - } - -Test your website using Pelican. All links should be colored red. - -Read [this post](avoid-unnecessary-http-requests) to make sure your site's page -speed does not decrease due to additional HTTP request. - -# Change Syntax Highlight Theme - -Elegant uses [Solarized theme](http://ethanschoonover.com/solarized) for syntax -highlighting. To replace it, copy contents of your preferred theme's CSS style -sheet into `custom.css`. - -Alternatively, you can replace contents of `pygments.css` with your theme's -style sheet. - -If you feel like experimenting with different themes then [this -repository](https://github.com/uraimo/pygments-vimstyles) has Pygments CSS of -Vim themes. [This one](https://github.com/richleland/pygments-css) has Pygments -CSS of built-in styles. Do not forget to change `.codehilite` CSS class -identifier to `.highlight`. Code blocks in Pelican generated HTML use -`.highlight` class. - -# Change Labels - -It is quite possible you will feel the need to tweak labels of different -sections or widgets. For example, change label of [social -widget](/how-to-display-your-social-media-profiles) from "Contact" to "Stay in -Touch". - -Don't worry! We got you covered! - -Elegant has all the customizable variables in one place. [`_defaults.html` -file](https://github.com/Pelican-Elegant/elegant/blob/master/templates/_includes/_defaults.html). - - :::bash - templates/_includes/_defaults.html - -Let's see how can we change social widget label. - - #!jinja - {# Label for the list of social profiles #} - {% if not SOCIAL_PROFILE_LABEL %} - {% set SOCIAL_PROFILE_LABEL = 'Contact' %} - {% else %} - {% set SOCIAL_PROFILE_LABEL = SOCIAL_PROFILE_LABEL %} - {% endif %} - -Line 1, text enclosed in `{# #}` is a comment, which says this section is about -"Label for the list of social profiles". - -The text in all capital case `SOCIAL_PROFILE_LABEL` is the actual variable. - -Line 3 says `SOCIAL_PROFILE_LABEL` is set to `Contact`. - -To change this value, assign it a different value in your Pelican -configuration, `pelicanconf.py`. - - :::python - SOCIAL_PROFILE_LABEL = 'Stay in Touch' - -That's it. The title of social widget will change. There are several others -labels that you can customize easily without touching Elegant's source code. diff --git a/documentation/content/Elegant - Pelican Theme/elegant-theme.md b/documentation/content/Elegant - Pelican Theme/elegant-theme.md deleted file mode 100644 index f0c22e6c..00000000 --- a/documentation/content/Elegant - Pelican Theme/elegant-theme.md +++ /dev/null @@ -1,87 +0,0 @@ -Title: Elegant -Subtitle: Why it is the best Pelican theme -Date: 2013-08-27 23:20 -Category: Elegant - Pelican Theme -Tags: jinja2, bootstrap, pelican-theme, font-awesome -Summary: Elegant is a minimal, stylish and responsive Pelican theme. Its unique features are search, Mailchimp, twitter card, and custom 404 page. -Slug: elegant-best-pelican-theme-features -comment_id: 2189d14-elegant-a-theme-for-pelican -modified: 2013-10-11 23:00 -keywords: pelican theme, responsive theme, tipue search - -[TOC] - -What makes Elegant so special? - -## Search - -Static sites usually do not offer search. Elegant uses [Tipue -Search](http://www.tipue.com/search/)- an open source jQuery plugin, to offer -search for your static site. - -There are two search modes. - -1. **JSON Mode** Your site pages will be stored in JSON at your server. Tipue - Search will use AJAX to access it and render search result. You need [Tipue - Search plugin](https://github.com/getpelican/pelican-plugins) to use this - mode. -1. **Live Mode Search** Tipue Search will fetch your site using Sitemap, index - it and store it in the visitor's cache. This mode requires [Sitemap - plugin](https://github.com/getpelican/pelican-plugins). - -Use JSON mode if you value speed, or have a large site, or don't want to -overwhelm your host server for every search query. - -Here is how the search result looks like - -![Search result for App Store]({static}/images/elegant-theme_search-result.png) - -Search box is part of main navigation menu so that visitor can search from any -page. - -![Search box]({static}/images/elegant-theme_search-box.png) - -## Custom 404 Page - -Elegant has a custom Error 404 page for your readers. - -![Error 404 page]({static}/images/elegant-theme_error-404-page.png) - ---- - -## Elegant - Technical Nitty-Gritty - -### License - -The license requires that you give credit to me, Talha Mansoor, as the author -of the Elegant theme on every site that uses this theme. I have placed the -attribution in the footer of every page. Do not remove it. If you need to -remove or change the style of the attribution, please get in [touch with -me](http://oncrashreboot.com/#about-me) first. - -Along with this attribution clause, Elegant theme is licensed under The MIT -License. - -If you use my theme, I would love to hear from you. [Get in -touch](http://oncrashreboot.com/#about-me) and let me know about it. I may link -to your site too. - -### Contribute - -Front end design is not my strong suite. I must have made some blunders in this -design unknowingly. Please don't let me go away with buggy code. - -- File bugs at [Github - issues](https://github.com/Pelican-Elegant/elegant/issues) -- Share your ideas about the design in the comments below -- And most of all contribute improvements to [this - project](https://github.com/Pelican-Elegant/elegant/) - -There are two problem areas that I can think of, - -1. Internet Explorer support -1. Web safe fonts. I developed this theme on a MacBook Retina. Although I have - tried to make sure it looks great on all platforms but it still needs polish - -Besides these, there must be other bugs that I haven't noticed yet. I need your -help to hunt them down and make them behave. diff --git a/documentation/content/Elegant - Pelican Theme/favicons-speed-dial-icons.md b/documentation/content/Elegant - Pelican Theme/favicons-speed-dial-icons.md index ee6aded3..26080f38 100644 --- a/documentation/content/Elegant - Pelican Theme/favicons-speed-dial-icons.md +++ b/documentation/content/Elegant - Pelican Theme/favicons-speed-dial-icons.md @@ -1,3 +1,4 @@ +--- Title: How to set Shortcut Icons Tags: pelican-theme, web-design Category: Elegant - Pelican Theme @@ -7,6 +8,8 @@ Disqus_identifier: x0giyfl-how-to-set-shortcut-icons Subtitle: Summary: Elegant lets you set Favicon, Opera Speed Dial icon, and shortcut icons for Apple iOS and Android devices. Keywords: +authors: Talha Mansoor +--- Elegant supports Favicon, Opera Speed Dial, and shortcut or launcher icons on Apple iOS and Android devices. These are disabled by default to avoid diff --git a/documentation/content/Elegant - Pelican Theme/testimonials.md b/documentation/content/Elegant - Pelican Theme/testimonials.md index 703f6920..dd847b29 100644 --- a/documentation/content/Elegant - Pelican Theme/testimonials.md +++ b/documentation/content/Elegant - Pelican Theme/testimonials.md @@ -1,3 +1,4 @@ +--- Title: What People Say About Elegant Tags: pelican-theme, testimonials Category: Elegant - Pelican Theme @@ -7,6 +8,8 @@ Disqus_identifier: qryv67o-what-people-say-about-elegant Subtitle: Summary: Keywords: +authors: Talha Mansoor +--- > Thanks for this amazing project. diff --git a/documentation/content/Extra Customization/change-labels.md b/documentation/content/Extra Customization/change-labels.md new file mode 100644 index 00000000..27b7242a --- /dev/null +++ b/documentation/content/Extra Customization/change-labels.md @@ -0,0 +1,47 @@ +--- +authors: Talha Mansoor +Title: Change Labels +Tags: unique +Date: 2019-07-03 20:20 +Slug: change-labels +Category: Extra Customization +--- + +It is quite possible you will feel the need to tweak labels of different +sections or widgets. For example, change label of [social +widget](/how-to-display-your-social-media-profiles) from "Contact" to "Stay in +Touch". + +Don't worry! We got you covered! + +Elegant has all the customizable variables in one place. [`_defaults.html` +file](https://github.com/Pelican-Elegant/elegant/blob/master/templates/_includes/_defaults.html). + + :::bash + templates/_includes/_defaults.html + +Let's see how can we change social widget label. + + #!jinja + {# Label for the list of social profiles #} + {% if not SOCIAL_PROFILE_LABEL %} + {% set SOCIAL_PROFILE_LABEL = 'Contact' %} + {% else %} + {% set SOCIAL_PROFILE_LABEL = SOCIAL_PROFILE_LABEL %} + {% endif %} + +Line 1, text enclosed in `{# #}` is a comment, which says this section is about +"Label for the list of social profiles". + +The text in all capital case `SOCIAL_PROFILE_LABEL` is the actual variable. + +Line 3 says `SOCIAL_PROFILE_LABEL` is set to `Contact`. + +To change this value, assign it a different value in your Pelican +configuration, `pelicanconf.py`. + + :::python + SOCIAL_PROFILE_LABEL = 'Stay in Touch' + +That's it. The title of social widget will change. There are several others +labels that you can customize easily without touching Elegant's source code. diff --git a/documentation/content/Extra Customization/custom-404.md b/documentation/content/Extra Customization/custom-404.md new file mode 100644 index 00000000..f48ed6d3 --- /dev/null +++ b/documentation/content/Extra Customization/custom-404.md @@ -0,0 +1,19 @@ +--- +authors: Talha Mansoor +Title: Custom 404 Page +Tags: unique +Date: 2019-07-03 20:07 +Slug: custom-404-page +Summary: Elegant has a custom 404 page +Category: Extra Customization +--- + +Elegant has a custom Error 404 page for your readers. + +![Error 404 page]({static}/images/elegant-theme_error-404-page.png) + +To enable, add `404` to your `DIRECT_TEMPLATES` in pelican configuration. + +```python +DIRECT_TEMPLATES = (('index', 'tags', 'categories','archives', '404')) +``` diff --git a/documentation/content/Extra Customization/custom-style.md b/documentation/content/Extra Customization/custom-style.md new file mode 100644 index 00000000..b8297745 --- /dev/null +++ b/documentation/content/Extra Customization/custom-style.md @@ -0,0 +1,52 @@ +--- +authors: Talha Mansoor +Title: Customize Style +Tags: unique +Date: 2019-07-03 20:14 +Slug: customize-style +Category: Extra Customization +--- + +To customize Elegant's visual style, use +[`custom.css`](https://github.com/Pelican-Elegant/elegant/blob/master/static/css/custom.css). +You can override Elegant's visual style like font, color, spacing etc using +this sheet. This empty style sheet is present at following path in your Elegant +folder, + + :::bash + static/css/custom.css + +Find the code of the element you want to customize in +[`elegant.css`](https://github.com/Pelican-Elegant/elegant/blob/master/static/css/elegant.css). +Copy the element's selector and styles, and paste it in `custom.css`. Edit this +CSS code and customize it to your liking. + +Your customizations will override whatever rules are defined in `elegant.css`. + +Let's take a look how you can change the style of hyperlinks in an article. +Following is the relevant code, + + :::css + article p:not(#list-of-translations):not(#post-share-links) a, + article ol a, + article div.article-content ul:not(.articles-timeline):not(.related-posts-list) a { + + border-bottom: thin dashed #A9A9A9; + color: #000; + } + +Copy and paste it in `custom.css`. Change color to red for example, + + :::css + article p:not(#list-of-translations):not(#post-share-links) a, + article ol a, + article div.article-content ul:not(.articles-timeline):not(.related-posts-list) a { + + border-bottom: thin dashed #A9A9A9; + color: red; + } + +Test your website using Pelican. All links should be colored red. + +Read [this post]({filename}../Supported Plugins/assets-plugin.md) to make sure your site's page +speed does not decrease due to additional HTTP request. diff --git a/documentation/content/Extra Customization/customize-elegant.md b/documentation/content/Extra Customization/customize-elegant.md new file mode 100644 index 00000000..b03e9b07 --- /dev/null +++ b/documentation/content/Extra Customization/customize-elegant.md @@ -0,0 +1,23 @@ +--- +Title: How to Customize Elegant +Tags: config +Category: Extra Customization +Date: 2014-03-24 14:05 +Slug: how-to-customize-elegant +Disqus_identifier: ale31i7-how-to-customize-elegant +Subtitle: +Summary: You can customize every aspect of Elegant without touching the source code +Keywords: +authors: Talha Mansoor +--- + +[TOC] + +You can change Elegant's look, color palette, font, size, and even labels used +for widgets, sections and plugins. + +Elegant is best maintained when you treat it as a separate resource in your +project. Do not edit template files, JavaScript code and style sheets. This +practice will make upgrading Elegant fuss free process. + +Instead see the guides in ["Extra Customization" category](categories.html#extra-customization-ref). diff --git a/documentation/content/Extra Customization/meta-data.md b/documentation/content/Extra Customization/meta-data.md new file mode 100644 index 00000000..a12043d7 --- /dev/null +++ b/documentation/content/Extra Customization/meta-data.md @@ -0,0 +1,34 @@ +--- +authors: Talha Mansoor +Title: Metadata +Tags: unique +Date: 2019-07-03 20:44 +Slug: metadata +Category: Extra Customization +--- + +Pelican uses [file +metadata](http://docs.getpelican.com/en/latest/getting_started.html#file-metadata) +from your articles and pages text files to get information about your posts, +like tags, authors etc. + +On top of _"official"_ metadata, Elegant uses some optional metadata that you +can use in your articles and pages. + +1. `summary` used for [Search Engine + Optimization](search-engine-and-social-media-optimization#search-engine-optimization-seo) +1. `subtitle` used to set [article + subtitle]({filename}../Appearance and Style/article-subtitle.md) +1. `keywords` used for [Search Engine + Optimization](search-engine-and-social-media-optimization#search-engine-optimization-seo) +1. `modified` used to set [last updated time](how-does-modified-metadata-works) + of the article +1. `series_title` used with [`multi_part` plugin](how-to-use-multi-part-plugin) +1. `featured_image` used for [Social Media + Optimization](search-engine-and-social-media-optimization#social-media-optimization-smo) +1. `share_post_intro` used with [`share_post` + plugin](how-to-use-social-sharing-plugin) +1. `comments_intro` used with + [comments]({filename}../Comments/invite-comments.md) +1. `comment_id` used with + [comments]({filename}../Comments/comment-id.md) diff --git a/documentation/content/Footer/add-license.md b/documentation/content/Footer/add-license.md index aa7f6e41..ff8c12c9 100644 --- a/documentation/content/Footer/add-license.md +++ b/documentation/content/Footer/add-license.md @@ -1,9 +1,12 @@ +--- Title: Add License to your Site Tags: nuances Category: Footer Date: 2014-04-22 16:23 Slug: add-license-to-your-site Summary: You can display your preferred license in the footer +authors: Talha Mansoor +--- You can optionally define `SITE_LICENSE` variable in Pelican configuration. It will appear in the footer of the site. diff --git a/documentation/content/Footer/hosted-on.md b/documentation/content/Footer/hosted-on.md index 513ccf33..619c753f 100644 --- a/documentation/content/Footer/hosted-on.md +++ b/documentation/content/Footer/hosted-on.md @@ -1,5 +1,6 @@ --- Title: Show Your Host Information +authors: Talha Mansoor Tags: nuances layout: post date: 2019-06-30 11:54 diff --git a/documentation/content/Footer/site-subtitle.md b/documentation/content/Footer/site-subtitle.md index 82cf329c..fb757f8e 100644 --- a/documentation/content/Footer/site-subtitle.md +++ b/documentation/content/Footer/site-subtitle.md @@ -1,9 +1,12 @@ +--- Title: Add Site Subtitle Tags: nuances Category: Footer Date: 2014-04-22 16:23 Slug: add-site-subtitle Summary: You can add and display a site subtitle +authors: Talha Mansoor +--- You can optionally define `SITE_SUBTITLE` variable in Pelican configuration. It will appear in the footer of the site. diff --git a/documentation/content/Landing Page/about-me.md b/documentation/content/Landing Page/about-me.md index 834d9875..09175a04 100644 --- a/documentation/content/Landing Page/about-me.md +++ b/documentation/content/Landing Page/about-me.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Write About Me Tags: remarkable, unique, home layout: post diff --git a/documentation/content/Landing Page/landing-page.md b/documentation/content/Landing Page/landing-page.md index 9980ef5c..2a1293b2 100644 --- a/documentation/content/Landing Page/landing-page.md +++ b/documentation/content/Landing Page/landing-page.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Unique Home Page Features Tags: home, remarkable, unique, guide layout: post diff --git a/documentation/content/Landing Page/projects-list.md b/documentation/content/Landing Page/projects-list.md index 8a70606c..3097296d 100644 --- a/documentation/content/Landing Page/projects-list.md +++ b/documentation/content/Landing Page/projects-list.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Projects List Tags: remarkable, unique, home layout: post diff --git a/documentation/content/Landing Page/recent-articles.md b/documentation/content/Landing Page/recent-articles.md index 57d7810c..5ed1bd38 100644 --- a/documentation/content/Landing Page/recent-articles.md +++ b/documentation/content/Landing Page/recent-articles.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Recent Articles List Tags: remarkable, unique, home layout: post diff --git a/documentation/content/Landing Page/welcome.md b/documentation/content/Landing Page/welcome.md index 7b44e3ba..8222f4f2 100644 --- a/documentation/content/Landing Page/welcome.md +++ b/documentation/content/Landing Page/welcome.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Write Welcome Message Tags: remarkable, unique, home layout: post diff --git a/documentation/content/Mailing List/freelists.md b/documentation/content/Mailing List/freelists.md index cc0915a5..c94e11a0 100644 --- a/documentation/content/Mailing List/freelists.md +++ b/documentation/content/Mailing List/freelists.md @@ -6,6 +6,7 @@ Date: 2018-07-05 23:20 comments: false Slug: add-freelists Category: Mailing List +authors: Talha Mansoor --- Elegant shows a form to subscribe to your newsletter, above the fold, in the right section of every article. diff --git a/documentation/content/Mailing List/mailchimp.md b/documentation/content/Mailing List/mailchimp.md index fce1a24a..a8798f08 100644 --- a/documentation/content/Mailing List/mailchimp.md +++ b/documentation/content/Mailing List/mailchimp.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: add-mailchimp Category: Mailing List +authors: Talha Mansoor --- 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. diff --git a/documentation/content/Monetization/amazon-one-link.md b/documentation/content/Monetization/amazon-one-link.md index 96640f8e..42394eec 100644 --- a/documentation/content/Monetization/amazon-one-link.md +++ b/documentation/content/Monetization/amazon-one-link.md @@ -1,5 +1,5 @@ --- -author: Pablo Iranzo Gómez (pablo.iranzo@gmail.com) +authors: Pablo Iranzo Gómez, Talha Mansoor title: Amazon OneLink Support tags: amazon, affiliates, income layout: post diff --git a/documentation/content/Release Notes/release-notes-2.0.0.md b/documentation/content/Release Notes/release-notes-2.0.0.md index 4baeea35..509caa83 100644 --- a/documentation/content/Release Notes/release-notes-2.0.0.md +++ b/documentation/content/Release Notes/release-notes-2.0.0.md @@ -17,7 +17,7 @@ With more than 4 years in the making, this release started "better late then nev With the [community spark re-ignited][announcement_community], this has become the biggest release since probably 1.0. And as such a very worthy release to carry the 2.0 crown. -[announcement_community]: {filename}../Announcements/community-driven-project.md +[announcement_community]: {filename}../Contributing/community-driven-project.md # Elegant v 2.0 is finally here! diff --git a/documentation/content/Building Readership/rss-feeds.md b/documentation/content/SEO and SMO/rss-feeds.md similarity index 97% rename from documentation/content/Building Readership/rss-feeds.md rename to documentation/content/SEO and SMO/rss-feeds.md index e47a4149..6e9515e8 100644 --- a/documentation/content/Building Readership/rss-feeds.md +++ b/documentation/content/SEO and SMO/rss-feeds.md @@ -1,12 +1,15 @@ +--- Title: How to show RSS feeds icon Tags: pelican-theme, font-awesome, web-design -Category: Building Readership +Category: SEO & SMO Date: 2014-03-17 15:28 Slug: how-to-show-rss-feeds-icon Disqus_identifier: ijvxwtg-how-to-show-rss-feeds-icon Subtitle: Summary: Elegant supports RSS and Atom feeds for your posts, categories and tags Keywords: +authors: Talha Mansoor +--- RSS feeds is the oldest and arguably the most used format to publish blog updates. Its use is not limited to RSS aggregators and readers. Tools like diff --git a/documentation/content/SEO and SMO/seo-social-media-tags.md b/documentation/content/SEO and SMO/seo-social-media-tags.md index 92896c45..2d94f57f 100644 --- a/documentation/content/SEO and SMO/seo-social-media-tags.md +++ b/documentation/content/SEO and SMO/seo-social-media-tags.md @@ -1,3 +1,4 @@ +--- Title: Search Engine and Social Media Optimization Tags: crawler, social-media, web-analytics Category: SEO & SMO @@ -6,6 +7,8 @@ Slug: search-engine-and-social-media-optimization Disqus_identifier: 7mh4xjn-search-engine-and-social-media-optimization Summary: Keywords: +authors: Talha Mansoor +--- [TOC] diff --git a/documentation/content/Building Readership/social-profiles-sidebar.md b/documentation/content/SEO and SMO/social-profiles-sidebar.md similarity index 98% rename from documentation/content/Building Readership/social-profiles-sidebar.md rename to documentation/content/SEO and SMO/social-profiles-sidebar.md index f972b034..65966588 100644 --- a/documentation/content/Building Readership/social-profiles-sidebar.md +++ b/documentation/content/SEO and SMO/social-profiles-sidebar.md @@ -1,12 +1,15 @@ +--- Title: How to display your Social Media Profiles Tags: pelican-theme, font-awesome, social-media, web-design -Category: Building Readership +Category: SEO & SMO Date: 2014-01-27 00:28 Slug: how-to-display-your-social-media-profiles Disqus_identifier: k7fpj4y-how-to-display-your-social-media-profiles Subtitle: Summary: Elegant displays links to your social media profiles in sidebar in a customizable manner Keywords: +authors: Talha Mansoor +--- Bloggers use different tools to connect with their readers, engage in discussion with them, and create a loyal following of fans. These tools range diff --git a/documentation/content/Search/tipue-search.md b/documentation/content/Search/tipue-search.md new file mode 100644 index 00000000..3daa6a86 --- /dev/null +++ b/documentation/content/Search/tipue-search.md @@ -0,0 +1,31 @@ +--- +authors: Talha Mansoor +Title: Add Search to your Site +Tags: unique +Date: 2019-07-03 19:56 +Slug: add-tipue-search +Summary: Elegant lets you add search to your static site +Category: Search +--- + +Static sites usually do not offer search. Elegant uses [Tipue +Search](http://www.tipue.com/search/)- an open source jQuery plugin, to offer +search for your static site. + +Here is how the search result looks like + +![Search result for App Store]({static}/images/elegant-theme_search-result.png) + +Search box is part of main navigation menu so that visitor can search from any +page. + +![Search box]({static}/images/elegant-theme_search-box.png) + +## Configuration + +To enable search, you need to enable `tipue_search` plugin and add `search` to `DIRECT_TEMPLATES` in your pelican configuration + +```python +PLUGINS = [tipue_search'] +DIRECT_TEMPLATES = (('index', 'tags', 'categories','archives', 'search')) +``` diff --git a/documentation/content/Taxonomy/article-count.md b/documentation/content/Taxonomy/article-count.md index d1d89664..286b724e 100644 --- a/documentation/content/Taxonomy/article-count.md +++ b/documentation/content/Taxonomy/article-count.md @@ -1,5 +1,6 @@ --- Title: Articles Count With Every Tag & Category +authors: Talha Mansoor Tags: nuances layout: post Date: 2013-08-27 23:20 diff --git a/documentation/content/Taxonomy/filter-tags.md b/documentation/content/Taxonomy/filter-tags.md index c1abcf67..8de7696f 100644 --- a/documentation/content/Taxonomy/filter-tags.md +++ b/documentation/content/Taxonomy/filter-tags.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Live Filter for Tags Tags: nuances, search layout: post diff --git a/documentation/content/Taxonomy/zero-clutter-category.md b/documentation/content/Taxonomy/zero-clutter-category.md index 0f538a1e..8e752e66 100644 --- a/documentation/content/Taxonomy/zero-clutter-category.md +++ b/documentation/content/Taxonomy/zero-clutter-category.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: zero-clutter-categories Category: Taxonomy +authors: Talha Mansoor --- Pelican by default creates a separate page for each category. Themes list all diff --git a/documentation/content/pages/contribute.md b/documentation/content/pages/contribute.md deleted file mode 100644 index eb5fab72..00000000 --- a/documentation/content/pages/contribute.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -author: Pablo Iranzo Gómez (pablo.iranzo@gmail.com) -title: Contribute -tags: elegant, contribute -layout: page -date: 2019-01-14 7:30:47 +0100 -comments: true -category: Development -description: ---- - -[Elegant](https://github.com/Pelican-Elegant/elegant) is a feature rich-theme, driven by it's users. - -Contributing to the theme comes in different and all equally valuable ways - -- [Feedback (Bug reports, enhancement requests, etc)](https://github.com/pelican-elegant/elegant/issues/) -- [Documentation feedback/improvements/examples](https://github.com/pelican-elegant/documentation/issues/) -- Feature creation via Pull Requests on open issues -- Pull Request reviews, to comment on approach, code cleanup, etc - -Even a little feature that you might be missing, could be a big impact to other users that might not even have considered it before, so... - -Speak your mind or put your hands to make Elegant even better! - -Check <https://github.com/Pelican-Elegant/elegant/blob/master/CONTRIBUTING.md> for more details on how to help us improve! diff --git a/documentation/pelicanconf.py b/documentation/pelicanconf.py index 04b7d4ee..87a63e29 100644 --- a/documentation/pelicanconf.py +++ b/documentation/pelicanconf.py @@ -69,8 +69,7 @@ ("RSS", SITEURL + "/feeds/all.atom.xml"), ) -CLAIM_GOOGLE = "Bk4Z5ucHLyPXqlZlj5LzANpYBBSvxqBW4E8i-Kwf-bQ" -CLAIM_BING = "8FF1B025212A47B5B27CC47163A042F0" +CLAIM_BING = "BC16AEBED17872F083B3E1E7A67454BD" # Elegant theme STATIC_PATHS = ["theme/images", "images", "extra/_redirects"] @@ -124,11 +123,25 @@ "url": "https://github.com/Pelican-Elegant/elegant", "description": "Source code of Elegant theme", }, + { + "name": "Issue Tracker", + "url": "https://github.com/Pelican-Elegant/elegant/issues", + "description": "Give your feedback, ask questions or report issues", + }, + { + "name": "Roadmap", + "url": "https://github.com/Pelican-Elegant/elegant/milestones", + "description": "See planned features and estimated release dates", + }, + { + "name": "onCrashReboot", + "url": "https://www.oncrashreboot.com/", + "description": "Home page of Elegant creator and lead developer", + }, { "name": "Pelican", "url": "https://github.com/getpelican/pelican/", - "description": "Static site generator that supports Markdown and" - " reST syntax", + "description": "Static site generator that powers Elegant", }, { "name": "Pelican Plugins", @@ -138,3 +151,14 @@ ] LANDING_PAGE_TITLE = "Elegant – Why it is the Best Pelican Theme" + +AUTHORS = { + "Talha Mansoor": { + "url": "https://www.oncrashreboot.com/", + "blurb": "is the creator and lead developer of Elegant theme.", + }, + "Pablo Iranzo Gómez": { + "url": "http://iranzo.github.io", + "blurb": "has been involved with open source projects for more than a decade.", + }, +} diff --git a/documentation/publishconf.py b/documentation/publishconf.py index d703cd88..baa32e51 100644 --- a/documentation/publishconf.py +++ b/documentation/publishconf.py @@ -16,25 +16,19 @@ SITEURL = "https://elegant.oncrashreboot.com" FEED_ALL_ATOM = "feeds/all.atom.xml" CATEGORY_FEED_ATOM = "feeds/{slug}.atom.xml" - - if os.environ.get("STAT_COUNTER_PROJECT_PROD") and os.environ.get( - "STAT_COUNTER_SECURITY_PROD" - ): - STAT_COUNTER_PROJECT = os.environ.get("STAT_COUNTER_PROJECT_PROD") - STAT_COUNTER_SECURITY = os.environ.get("STAT_COUNTER_SECURITY_PROD") - GOOGLE_ANALYTICS = os.environ.get("GOOGLE_ANALYTICS_PROD") + CLAIM_BING = os.environ.get("CLAIM_BING_PROD") + STAT_COUNTER_PROJECT = os.environ.get("STAT_COUNTER_PROJECT_PROD") + STAT_COUNTER_SECURITY = os.environ.get("STAT_COUNTER_SECURITY_PROD") + GOOGLE_ANALYTICS = os.environ.get("GOOGLE_ANALYTICS_PROD") elif os.environ.get("CONTEXT") == "branch-deploy" and os.environ.get("HEAD") == "next": SITENAME = "Elegant (Next)" SITESUBTITLE = "Pre Release Documentation of The Best Pelican Theme" SITEURL = "https://next.elegant.oncrashreboot.com" LANDING_PAGE_TITLE = "Elegant (Next) – Why it is the Best Pelican Theme" - if os.environ.get("STAT_COUNTER_PROJECT_NEXT") and os.environ.get( - "STAT_COUNTER_SECURITY_NEXT" - ): - STAT_COUNTER_PROJECT = os.environ.get("STAT_COUNTER_PROJECT_NEXT") - STAT_COUNTER_SECURITY = os.environ.get("STAT_COUNTER_SECURITY_NEXT") - GOOGLE_ANALYTICS = os.environ.get("GOOGLE_ANALYTICS_NEXT") + STAT_COUNTER_PROJECT = os.environ.get("STAT_COUNTER_PROJECT_NEXT") + STAT_COUNTER_SECURITY = os.environ.get("STAT_COUNTER_SECURITY_NEXT") + GOOGLE_ANALYTICS = os.environ.get("GOOGLE_ANALYTICS_NEXT") else: SITEURL = ""