Gitea doesn't like RST files, so MD

This commit is contained in:
Jeff MacKinnon 2022-11-14 12:09:32 -04:00
parent f0249c199a
commit 917d50bd63
2 changed files with 61 additions and 46 deletions

61
README.md Normal file
View file

@ -0,0 +1,61 @@
# theme-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.
```
# ####################################################
# JeffTheme variables
# ####################################################
#DIRECT_TEMPLATES = ['posts'] # If you already have a direct templates just add posts.
#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 = ''
# 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.
COMMENTS = False
# That's all folks
# ####################################################
```
You can copy the entire thing into your `pelicanconf.py` file and make the changes for your site.

View file

@ -1,46 +0,0 @@
=======================
theme-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.
.. code:: python
#
# Theme variables
#
## The search things
DUCKDUCKGOSEARCHURL = 'Your URL'
BIO_IMAGE = 'image' # Make sure that this is in the "images" folder
## The Social Things
SOCIAL_TWITTER = 'jeffmackinnon'
SOCIAL_GITHUB = 'jeffmackinnon'
SOCIAL_LINKEDIN = 'jeffmackinnon'
SOCIAL_MASTODON = 'https://bluenoser.me/@Jeff'
#SOCIAL_FLICKR = ''
#MICROBLOG = ''
CONTACT_PHONE_NUM = '+# (###) ###-####'
CONTACT_EMAIL = 'name@url.tld'
#CONTACT_HOME_ADDR = ''
#CONTACT_BUSINESS_ADDR =''
THEME_COLOUR = 'css-blue' # There are only 2 colours right now, pink and blue. Pink is Default
SITELICENSE = '' # Change to what you want.
#
#Frontpage customization
#
TAGLINEHEAD = 'This is a header'
TAGLINE = 'This is the tagline'
CORNERSTONE_CONTENT = True # If true add the html you want in include/cornerstone.html
NEWSLETTER = '' # Put the HTML or JS from your provider here.
INCLUDECATEGORY = True # This includes the Category in the article list
MOREBUTTON = True #This adds the "MORE" to the article list
# That's all folks
You can copy the entire thing into your ``pelicanconf.py`` file and make the changes for your site.