jeff/jeffs-pelican-theme
1
0
Fork 0
Code Issues Pull requests Releases 2 Packages Activity

Updating the configuration and settings.

Browse source
This commit is contained in:
Jeff MacKinnon 2022-11-14 13:55:04 -04:00
parent 917d50bd63
commit c07ded3af8
1 changed files with 77 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

106
README.md
View file

@ -2,9 +2,13 @@
The base pelican theme for my site, `jeffmackinnon.com <https://jeffmackinnon.com>`__
The base pelican theme for my site, [jeffmackinnon.com](https://jeffmackinnon.com)
There are some variables that you can add to the ``pelicanconf.py`` file that make things look good.
## Configuration
The first step is the pelicanconf.py file.
There are some variables that you can add to the `pelicanconf.py` file that make things look good.
```
@ -16,46 +20,90 @@ There are some variables that you can add to the ``pelicanconf.py`` file that ma
#THEME_COLOUR = 'css-blue' # Leave commented
## The search things
DUCKDUCKGOSEARCHURL = 'jeffmackinnon.com'
BIO_IMAGE = 'jeffmackinnon.jpg' # Make sure that this is in the "images" folder
SHOWCATEGORIES = True
SHOWTAGS = False
## The Social Things
SOCIAL_SHARE = True
#SOCIAL_TWITTER = '<username>'
#SOCIAL_GITHUB = '<username>'
#SOCIAL_LINKEDIN = '<username>'
#SOCIAL_FLICKR = '<username>'
#SOCIAL_MASTODON = 'https://<instance>/@<username>'
MICROBLOG = 'microblog'
MASTODON_COMMENTS = False
TWITTER_COMMENTS = True
COMMENTS = False
#Contact Things
#CONTACT_PHONE_NUM = '+1 (902) 237-9984'
#CONTACT_EMAIL = 'jeff@jeffmackinnon.com'
CONTACT_HOME_ADDR = 'Halifax, NS'
#CONTACT_BUSINESS_ADDR =''
SITELICENSE = '<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.'
TRACKING = False
IMAGETRACKINGCODE = ''
## Sidebar things
#
#DUCKDUCKGOSEARCHURL = '' # This is the only search that I have working right now.
BIO_IMAGE = 'jeffmackinnon.jpg' # Make sure that this is in the "images" folder
SHOWCATEGORIES = True
SHOWTAGS = False
CONTACT_PHONE_NUM = '+1 (902) 555-1234'
CONTACT_EMAIL = 'support@thisdoamin.co'
CONTACT_HOME_ADDR = 'Nova Scotia'
#CONTACT_BUSINESS_ADDR =''
# The Social Things
#
SOCIAL_SHARE = True
SOCIAL_TWITTER = 'jeffmackinnon'
SOCIAL_GITHUB = 'Jeffmackinnon'
SOCIAL_LINKEDIN = 'jeffmackinnon'
SOCIAL_FLICKR = 'jeffmackinnon'
SOCIAL_MASTODON = 'https://bluenoser.me/@Jeff'
MICROBLOG = 'microblog'
# Frontpage customization
#
BANNER = True
TAGLINEHEAD = 'The cool headline'
TAGLINESUBHEAD = 'The sub-header'
TAGLINE = 'Now this is going to be super cool, think of all the things we can teach you about. It is going to be amazing'
BANNERLINK = 'services/'
BANNERIMAGE = 'images/20130923124523.jpg'
CORNERSTONE_CONTENT = True # If true add the html you want in include/cornerstone.html
NEWSLETTER = '' # place your newsletter embed information here
INCLUDECATEGORY = True # This includes the Category in the article list
MOREBUTTON = True #This adds the "MORE" to the article list
# This is for https://fediring.net/#table-of-members and is located in the sidebar
#
FEDIRING = False
FEDIRINGRANDOM = True
FEDIRINGURL = '' # This is needed because the SITEURL includes the https:// and Fediring doesn't want that part.
# Commenting
#
MASTODON_COMMENTS = False
MASTODON_EMBED = '' # This is where you add the Mastodon Embed code, it needs a overhaul so I will link to the repo when I have time to play with it.
TWITTER_COMMENTS = True
# I'm using HashOver for comments, but there are a few different ones that you can use.
COMMENTS = False
COMMENT_EMBED ='' # This is the emdbed code that you need for the comments.
# That's all folks
# ####################################################
```
You can copy the entire thing into your `pelicanconf.py` file and make the changes for your site.
## Second is the custom theme includes.
To make this configurable for a bunch of different sites I wanted to make sure that I can have a "custom" homepage for some of them.
To do this I have included a few templates in the `include` folder. Whether or not these are used is controlled by the configuration file.
- article_footer.html
- cornerstone.html
- trackingcode.html
The other files in there can be modified, but don't need to be.
> I'm not sure how this is going to work with an "installable" theme, which is what is holding me back. If you know how this could be done please message me ([mastodon](https://bluenoser.me/@Jeff)) or email jeffmackinnon@proton.me.
## RoadMap
In order of percieved importance, but not in the order that I will get them done.
- [ ] Make installable
- [ ] Create custom colours
- [ ] Figure out how to create a Dark Mode
### Roadmap notes
I would like for this to be installable, and once that is ready/working I will bind it as a release.
I would also like to have a couple colour themes so that I can use this exact theme for a few of the different sites that I would like to use it for, to make that work I will need different colour styles.
Finally, and probably similar to the above, I want to have it set up so that I can have a dark mode for each of those colour schemes. I really prefer dark mode for anything that has a lot of text, and not having it for my own theme/website is probably annoying for some people.