From 46faaea2b7fbed0c55edbcab8fc357fd514b8096 Mon Sep 17 00:00:00 2001 From: Alexandre Vicenzi Date: Tue, 6 Oct 2015 19:14:44 -0300 Subject: [PATCH] Add changelog. --- CHANGELOG.md | 13 ++++++ README.md | 109 +++------------------------------------------------ 2 files changed, 19 insertions(+), 103 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1c3acab --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,13 @@ +## 1.1 + +- [Allow custom CSS stylesheets to override the default one](https://github.com/alexandrevicenzi/Flex/pull/9) +- [Add Windows-specific font variants](https://github.com/alexandrevicenzi/Flex/pull/8) +- [Move the "tagged" bullet inside the conditional.](https://github.com/alexandrevicenzi/Flex/pull/7) +- [Add stack-overflow to supported social icons](https://github.com/alexandrevicenzi/Flex/pull/6) +- [Use THEME_STATIC_DIR for asset URL's](https://github.com/alexandrevicenzi/Flex/pull/5) +- [show summary for articles in index.html](https://github.com/alexandrevicenzi/Flex/pull/4) +- [Fixed email icon bug](https://github.com/alexandrevicenzi/Flex/pull/3) + +## 1.0 + +First release. diff --git a/README.md b/README.md index d239661..f18b418 100644 --- a/README.md +++ b/README.md @@ -19,110 +19,9 @@ A minimalist [Pelican](http://blog.getpelican.com/) theme. - Google Tag Manager - StatusCake -## Custom settings +## Need Docs? -See what you can customize. - -> Maybe some Pelican settings not work properly. - -| Name | What does it do? | -|:----:|------------------| -| SITETITLE | Site title to show in sidebar. | -| SITESUBTITLE | Short description to show below subtitle. | -| SITELOGO | Profile picture to show above author name (absolute url). | -| SITEDESCRIPTION | Site description to use in meta tags. | -| OG_LOCALE | language_TERRITORY for Open Graph. Default is `en_US`. | -| COPYRIGHT_YEAR | Copyright year to display on footer. | -| CC_LICENSE | Creative Commons License to show on footer. | -| MENUITEMS | A list of tuples (Title, URL) for additional menu items to appear on main menu. | -| LINKS | A list of tuples (Title, URL) for links to appear on the sidebar menu. | -| SOCIAL | A list of tuples (name, URL) to appear in the "social" section. | -| MAIN_MENU | Show main menu. | -| ROBOTS | Robots meta tag value. | -| ADD_THIS_ID | AddThis public id. | -| DISQUS_SITENAME | Disqus website's shortname to activate Disqus. | -| GOOGLE_ANALYTICS | Activate Google Analytics. | -| GOOGLE_TAG_MANAGER | Activate Google Tag Manager. | -| STATUSCAKE | Show StatusCake Uptime badge on footer. | - -### Example - -```python -AUTHOR = 'Foo Bar' -SITEURL = 'http://yoursite.com' -SITENAME = 'Foo Bar\'s Blog' -SITETITLE = 'Foo Bar' -SITESUBTITLE = 'Web Developer' -SITEDESCRIPTION = 'Foo Bar\'s Thoughts and Writings' -SITELOGO = 'http://yoursite.com/img/profile.png' - -FAVICON = SITEURL + '/images/favicon.ico' -ROBOTS = 'index, follow' - -COPYRIGHT_YEAR = 2015 -CC_LICENSE = { 'name': 'Creative Commons Attribution-ShareAlike', 'version':'4.0', 'slug': 'by-sa') } - -MAIN_MENU = True - -ADD_THIS_ID = 'ra-77hh6723hhjd' -DISQUS_SITENAME = 'yoursite' -GOOGLE_ANALYTICS = 'UA-1234-5678' -GOOGLE_TAG_MANAGER = 'GTM-ABCDEF' -STATUSCAKE = { 'trackid': 'your-id', 'days': 7 } -``` - -If you want a full working example take a look [here](https://github.com/alexandrevicenzi/blog/blob/master/pelicanconf.py). - -### How main menu works? - -If `MAIN_MENU = True`, the order is: Home, `MENUITEMS`, Atom and RSS if available. - -### How sidebar menu works? - -The order is Pages and `LINKS`. `LINKS` are shown in a new page. - -### How social menu works? - -All icons are provided by [Font Awesome](http://fortawesome.github.io/Font-Awesome/). - -A set of icons have custom background, for this you must follow the names below: - -- envelope-o (for email) -- facebook -- github -- github-alt -- google -- linkedin -- pinterest -- rss -- stack-overflow -- twitter -- youtube - -Example: - -```python -SOCIAL = (('linkedin', 'https://br.linkedin.com/in/alexandrevicenzi/en'), - ('github', 'https://github.com/alexandrevicenzi'),) -``` - -If you need more icons, you will need to add a custom background to keep all icons similar. - -## Custom File Metadata - -| Name | What does it do? | -|:----:|------------------| -| Summarize | Enable Home summary. | -| Cover | Cover image for social sharing (absolute url). | -| og_locale | Open graph locale for article. | - -By default, all article content is shown on Home. -If the article has a custom Summary, the custom summary is shown. -If the article has `Summarize: True` metadata, the default article summary is shown. - -## Code Highlight - -If you want to replace Pygments theme (default is GitHub) take a look at [Pygments Docs](http://pygments.org/) and replace `pygments.min.css`. +[Go to Wiki](https://github.com/alexandrevicenzi/Flex/wiki) ## Live example @@ -132,6 +31,10 @@ I'm using Flex in my [personal blog](http://blog.alexandrevicenzi.com/). ![Screenshot](https://github.com/alexandrevicenzi/Flex/blob/master/screenshot.png) +## Changelog + +[Click here](./CHANGELOG.md) + ## License MIT