Changes for v2.0a
This commit is contained in:
parent
8003f162ae
commit
cc6d96e3fb
1 changed files with 2 additions and 78 deletions
80
README.md
80
README.md
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
The base pelican theme for my site, [jeffmackinnon.com](https://jeffmackinnon.com)
|
||||
|
||||
This is version 2.0, which is very very different and "simple". If you are looking for the original theme check the release V1.0
|
||||
|
||||
## Configuration
|
||||
|
||||
The first step is the pelicanconf.py file.
|
||||
|
|
@ -16,17 +18,10 @@ There are some variables that you can add to the `pelicanconf.py` file that make
|
|||
|
||||
#DIRECT_TEMPLATES = ['posts'] # If you already have a direct templates just add posts.
|
||||
|
||||
THEME_COLOUR = 0 # Pick the colour.
|
||||
# 0 => default
|
||||
# 1 => Blue
|
||||
|
||||
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
|
||||
|
|
@ -35,39 +30,13 @@ 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'
|
||||
|
||||
# Frontpage customization
|
||||
#
|
||||
|
||||
#MINIMAL = True # If True the homepage will use the 'minimal_homepage.html template.
|
||||
# If minimal is set to true, the other configuration options below don't do anything.
|
||||
|
||||
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
|
||||
|
||||
# Article List Pages
|
||||
#
|
||||
INCLUDE_SUMMARY = False # Default True
|
||||
INCLUDE_TITLE = False # Default True
|
||||
INCLUDE_CATEGORY = True # Default False
|
||||
INCLUDE_IMAGE = True # Default False
|
||||
MOREBUTTON = True # This adds the "MORE" to the article list
|
||||
|
||||
MICROBLOG = 'microblog' # This caetgory will ALWAYS have just a picture and no headline or summary
|
||||
|
||||
# This is for https://fediring.net/#table-of-members and is located in the sidebar
|
||||
#
|
||||
|
|
@ -83,11 +52,6 @@ SHOW_TOP_IMAGE = True # This shows the article image at the top before the conte
|
|||
# Commenting
|
||||
#
|
||||
|
||||
# Mastodon Comments
|
||||
MASTODON_COMMENTS = False
|
||||
MASTODON_HOST = 'url.tld
|
||||
MASTODON_USER = 'user'
|
||||
|
||||
# If you use a hosted commenting engine like hashover, commento, etc.
|
||||
COMMENTS = False
|
||||
COMMENT_EMBED ='' # This is the emdbed code that you need for the comments.
|
||||
|
|
@ -104,7 +68,6 @@ To make this configurable for a bunch of different sites I wanted to make sure t
|
|||
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.
|
||||
|
|
@ -121,44 +84,5 @@ So, the below set up is for this [post](https://jeffmackinnon.com/20230511-new_f
|
|||
:image: {photo}microblog/865A0747.jpg
|
||||
:image_alt: Macro photo of a flower.
|
||||
|
||||
```
|
||||
### Mastodon comments
|
||||
|
||||
To use the mastodon commenting system you will need to edit the article with the mastodon id of where it is posted.
|
||||
|
||||
For example, for this [post with flowers](https://jeffmackinnon.com/20230704-sea-of-white-flowers.html) I have the following tags in the post:
|
||||
|
||||
```
|
||||
:date: 2023-07-04
|
||||
:author: Jeff
|
||||
:category: microblog
|
||||
:tags: flowers, year-of-flowers
|
||||
:slug: 20230704-sea-of-white-flowers
|
||||
:status: published
|
||||
:image: {photo}microblog/865A2210.JPG
|
||||
:alt_text_image: white flowers with yellow center.
|
||||
:mastodon_post_id: 110656661657103654
|
||||
|
||||
```
|
||||
|
||||
The critical one here is the `:mastodon_post_id:` with the ID of the mastodon post.
|
||||
|
||||
In the future this may be automatic using a plugin and some fancy JS.
|
||||
|
||||
|
||||
## RoadMap
|
||||
|
||||
In order of percieved importance, but not in the order that I will get them done.
|
||||
|
||||
- [ ] Make installable
|
||||
- [X] Create custom colours
|
||||
- [ ] Figure out how to create a Dark Mode
|
||||
- [ ] Create a minimal homepage option
|
||||
|
||||
### 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.
|
||||
Loading…
Reference in a new issue