Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2a00d3c
commit 3f9dddd
Showing
24 changed files
with
1,418 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) [2017] [Rahul Nair] | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
## Graymill - A minimal Pelican theme. | ||
|
||
Graymill is a minimal, responsive theme for the [Pelican](http://blog.getpelican.com/) static site generator. It is based on the [Milligram CSS framework](http://milligram.io/). | ||
|
||
### Demo | ||
|
||
See the theme in action at [muchBits](https://muchbits.com) | ||
|
||
### Features | ||
|
||
* Syntax highlighting for code blocks | ||
* Easy to install | ||
* Minimal/No Javascript (JS is only used in case Google Analytics is enabled). | ||
* Google Analytics Support | ||
* Responsive (Mobile Friendly Test on [Google](https://search.google.com/test/mobile-friendly?utm_source=mft&utm_medium=redirect&utm_campaign=mft-redirect&id=TT7gCU77TVUWMMbu4pmHsg)) | ||
|
||
## Installation | ||
|
||
* Clone the repository: | ||
```python | ||
git clone https://github.com/rn4ir/graymill.git | ||
``` | ||
* Create a `THEME` variable in your `pelicanconf.py` file and set its value to the location of ***graymill*** theme, like so: | ||
```python | ||
THEME = 'path/to/graymill' | ||
``` | ||
|
||
## Custom Variables | ||
|
||
(*Please refer to the sample pelicanconf.py contained in this repo for examples*) | ||
|
||
The ***Graymill*** theme use the following settings in the `pelicanconf.py`: | ||
|
||
### pelicanconf.py | ||
|
||
#### Social Icons: | ||
```python | ||
SOCIAL = (('linkedin', 'https://www.linkedin.com/in/username'), | ||
('github', 'https://github.com/username'), | ||
('twitter', 'https://twitter.com/username'), | ||
('facebook', 'https://facebook.com/userid'), | ||
) | ||
``` | ||
|
||
#### Pagination: | ||
```python | ||
DEFAULT_PAGINATION = 8 | ||
``` | ||
|
||
#### Home page parameters: | ||
|
||
```python | ||
SITEDESCRIPTION = 'your-site's-tagline' | ||
DISPLAY_SUMMARY = True | ||
DISPLAY_PAGES_ON_MENU = True | ||
``` | ||
|
||
#### Other Settings | ||
```python | ||
FAVICON = 'images/favicon.png' | ||
STATIC_PATHS = ['images', 'extras'] | ||
EXTRA_PATH_METADATA = { | ||
'extras/.htaccess': {'path': '.htaccess'}, | ||
'extras/robots.txt': {'path': 'robots.txt'}, | ||
``` | ||
|
||
#### For local development: | ||
``` | ||
SITEURL = 'http://localhost:8000' | ||
``` | ||
|
||
### publishconf.py | ||
|
||
When you are ready to publish your site add the following settings to `publishconf.py` file | ||
|
||
```python | ||
SITEURL = 'https://domain-name.tld' | ||
|
||
FEED_ALL_ATOM = 'feeds/all.atom.xml' | ||
CATEGORY_FEED_ATOM = 'feeds/%s.atom.xml' | ||
|
||
GOOGLE_ANALYTICS = "" | ||
``` | ||
|
||
For more information on publishing your site, please read the [Pelican publishing docs](http://docs.getpelican.com/en/3.6.3/publish.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
#!/usr/bin/env python | ||
# -*- coding: utf-8 -*- # | ||
from __future__ import unicode_literals | ||
|
||
# Basic information | ||
AUTHOR = u'author' | ||
AUTHOREMAIL = 'myemail [at] mydomain [dot] tld' | ||
SITENAME = u'siteName' | ||
SITEURL = 'http://muchbits.com' | ||
|
||
PATH = 'content' | ||
|
||
TIMEZONE = 'Asia/Kolkata' | ||
|
||
DEFAULT_LANG = u'en' | ||
THEME = 'themes/graymill' | ||
|
||
# Social widgets | ||
SOCIAL = (('twitter', 'https://twitter.com/'), | ||
('linkedin', 'https://www.linkedin.com/'), | ||
('github', 'https://github.com/'), | ||
('facebook', 'https://facebook.com/'), | ||
) | ||
|
||
DEFAULT_PAGINATION = 8 | ||
|
||
SITEDESCRIPTION = 'my custom tagline/description' | ||
|
||
# For post-summaries | ||
DISPLAY_SUMMARY = True | ||
|
||
# To display static pages like About, Contact etc. | ||
DISPLAY_PAGES_ON_MENU = True | ||
|
||
MENUITEMS = (('Home', SITEURL), | ||
) | ||
|
||
# Feed generation is usually not desired when developing | ||
FEED_ALL_RSS = False | ||
FEED_ALL_ATOM = False | ||
FEED_ALL_ATOM = None | ||
CATEGORY_FEED_ATOM = None | ||
TRANSLATION_FEED_ATOM = None | ||
AUTHOR_FEED_ATOM = None | ||
AUTHOR_FEED_RSS = None | ||
|
||
# Favicon (path relative to './content/') | ||
FAVICON = 'images/favicon.png' | ||
|
||
# To include custom static files like htaccess, robots, PDF files etc. (path relative to './content/') | ||
STATIC_PATHS = ['images', 'extras'] | ||
EXTRA_PATH_METADATA = { | ||
'extras/.htaccess': {'path': '.htaccess'}, | ||
'extras/robots.txt': {'path': 'robots.txt'}, | ||
} |
Oops, something went wrong.