AUTHOR = u'' # author name
SITENAME = u'' # sitename
SITEURL = '' # site url https://www.example.it
SITEDESCRIPTION = "" # meta description
BLOGNAME = u''
BLOG_OG_IMAGE = '' #the name of image used as open graph image https://ogp.me/
CSS_PATH = 'css' # legacy code, think about removing
IMG = "theme/img"
IMAGES_PATH = 'theme'
THEME = 'theme/dtheme'
LOCALE = 'en_US.utf8'
TIMEZONE = ''
DEFAULT_LANG = u'en'
TWITTERNAME = "" #twitter user name @example
COPY_YEAR = date.today().year # automatic updater for the copy year on the footer
PATH = 'content'
STATIC_PATHS = ['extra']
MENUITEMS = (('BLOG', '/blog/'),('ABOUT', '/about/'),)

# the template is made for a two menu items, blog and about page. In this way I can manage the menu without using a hamburger menu and without using a javascript. Also, I don't need more than two menu items right one. At the moment there is a misconfiguration and this settings field is also in publishconf.py file, better to use the one in the publishconf.

EXTRA_PATH_METADATA = { # use extra_path_metadata for static file needed in the root path. Remove the ones you don't need. Examples:
    'extra/robots.txt': {'path': 'robots.txt'},
    'extra/sw.js': {'path': 'sw.js'},
    'extra/manifest.json': {'path': 'manifest.json'},
    'extra/cookie_policy.pdf': {'path': 'cookie_policy.pdf'},
    'extra/privacy_policy.pdf': {'path': 'privacy_policy.pdf'},
    'extra/.htaccess': {'path': '.htaccess'}, # IMPORTANT, create your htaccess
    'extra/favicon.ico': {'path': 'favicon.ico'}
    }

GTM_HEAD = """ """ # Google tag manager script for the header section
GTM_BODY = """ """ # Google tag manager script for the body section

TRACKING = """ """ # I use this section to install custom tracking service like Google Analytics or other tools (fathom, plausible, goat analytics, Matomo, Piwik etc)

SCHEMA_WORKFOR = {
    "your company name": {
        "company url"
        } # add comma and continue adding key/values if needed
}
SCHEMA_ALUMNIOF = {
    "education organization name": {
        "education organization url"
        } # add comma and continue adding key/values if needed
}
SCHEMA_JOB = "" # your job title
SCHEMA_PERSONAL_DESCRIPTION = "" # your personal description

SCHEMA_LINK_SAMEAS = {
    ('', ''), # name and link of your same as (ex. "linkedin", "https://linkedin.com/myprofile"). Add comma and continue adding key/values if needed
}

SCHEMA_KNOWSABOUT = {
    ('', ''), # name and reference of the known topic (ex. "SEO", "https://en.wikipedia.org/wiki/Search_engine_optimization"). Add comma and continue adding key/values if needed
}

# settings for XML feeds
FEED_DOMAIN = SITEURL
FEED_MAX_ITEMS = 10
RSS_FEED_SUMMARY_ONLY = True
FEED_ALL_RSS = 'feeds/all.rss.xml'
FEED_ALL_ATOM = None
CATEGORY_FEED_RSS = 'feeds/{slug}.rss.xml'
CATEGORY_FEED_ATOM = None
TRANSLATION_FEED_ATOM = None
AUTHOR_FEED_ATOM = None
AUTHOR_FEED_RSS = None

# settings for direct templating and pagination
DIRECT_TEMPLATES = ['home','error','blog_index','sitemap']
DEFAULT_PAGINATION = False
PAGINATED_TEMPLATES = {'blog_index': 5, 'tag': 5, 'category': 5, 'author':None}
PAGINATION_PATTERNS = (
    (1, '{url}', '{save_as}'),
    (2, '{base_name}/{number}/', '{base_name}/{number}/index.html'),
)

# settings for URLs configurations
ARTICLE_URL = 'blog/{slug}/'
ARTICLE_SAVE_AS = 'blog/{slug}/index.html'
ARTICLE_ORDER_BY = 'reversed-date'

AUTHOR_URL = 'about/'
AUTHOR_SAVE_AS = 'about/index.html'

HOME_URL = 'index.html'
HOME_SAVE_AS = 'index.html'

BLOG_INDEX_URL = 'blog/'
BLOG_INDEX_SAVE_AS = 'blog/index.html'

CATEGORY_URL = 'cat/{slug}/'
CATEGORY_SAVE_AS = 'cat/{slug}/index.html'

SITEMAP_URL = 'sitemap/'
SITEMAP_SAVE_AS = 'sitemap/index.html'

ERROR_URL = '404/'
ERROR_SAVE_AS = '404/index.html'

# used in about page, as links for personal certifications. 
CERTIFICATION = True # set False to not show any certifaction logo
CERTIFICATIONS = { # add as many you need
    '': {
        'url': '',
        'title': '',
        'img': '',
        'alt_tag': ''
    }
}

AUTHORS = {
    'author name here': { # put the name of the author. I made this template as a single author blog, so this is your name
        'short_description': """""", # used for the author info card inside at the bottom of the articles
        'description': """ """, # used inside the about page, immediately below the authore picture
        'long_description': """ """, #this is the long description placed inside the author about page
        'url': '/about/',
        'image_jpg': '/theme/img/author/your-name.jpg', # used as author avatar
        'image_webp': '/theme/img/author/your-name.webp', # used as author avatar
        'image_schema': '/theme/img/author/your-name.jpg', # used for structured data
        'links': (('email', 'mailto:[email protected]'),
                  ('linkedin', ''),
                  ('twitter', ''),
                  ('RSS', '/feeds/all.rss.xml'),)
    }
}

# here you can set you categories. Putting new items inside the dictionary will create new categories pages. Categories can also talks about projects, they act the same way as blog listing about a single topic, it is just a way to see them.
CATEGORIES = {
    'blog': { # this is the main category, a kind of blog home. Give it the name you like, I call it "blog". 
        'description': "", # description of the blog, used both for meta description and as a category main description, if no "project_description" is defined
    },
    '': { # here you can specify a real category name
        'description': '',
        'logo_jpg': '/theme/img/cat/name.jpg', # "name" must be the name of the category
        'logo_webp': '/theme/img/cat/name.webp', # "name" must be the name of the category
        'project_info': True, # if True the category page will have several information at the bottom of the category name
        'project_description':'', # longer description of the category/project. If present, will replace the simpler "description"
        'project_tool':'', # tool used for the project management
        'project_lang': '', # lang used for the project
        'project_version': '', # project version
        'project_links': '', # link to the project website
        'project_author': '' # author of the project
    }
}

DISPLAY_CATEGORIES_ON_MENU = None
DISPLAY_PAGES_ON_MENU = None
RELATIVE_URLS = True # Uncomment following line if you want document-relative URLs when developing
LOAD_CONTENT_CACHE = False
CACHE_CONTENT = False

# Usefull for the author page. These information are used to create the project slider
PROJECTS = {
    '': { # here the name of the project
        'image_jpg':'', # just the name of the project main image, jpg file
        'image_webp':'', # just the name of the project main image, webp file
        'alt_tag':'', # alt tag for the project image inside the slider
        'description':"""""" # description of the project. It will appear under the slider image
    }
}

PLUGIN_PATHS = ['plugin']
PLUGINS = ['readtime', 'sitemap', 'cover_resizer', 'neighbors', 'pelican-toc', 'minification'] # some of theese plugins are needed for the template to corret working. Not tested without them.

# configuration for "minification" plugin. Not needed but usefull to reduce the size of the files.
MINIFY = {
  'remove_comments': True,
  'remove_all_empty_space': True,
  'remove_optional_attribute_quotes': False
}

# configuration for "sitemap" plugin. Not needed but usefull for seo purposes; assign for each key, the value you prefer.
SITEMAP = {
    "format": "xml",
    "priorities": {
        "articles": 1,
        "indexes": 0.5,
        "pages": 0.5
    },
    "changefreqs": {
        "articles": "monthly",
        "indexes": "weekly",
        "pages": "monthly"
    },
    'exclude': ['tag/', 'category/']
}

# configuration for the "pelican-toc" plugin. The theme should work without the plugin, but I recommend it. I just made some changes to the original plugin, but haven't proposed them to its developer yet.
TOC = {
    'TOC_INCLUDE_TITLE': 'false'
}

SITEURL = '' # website url
RELATIVE_URLS = False
MENUITEMS = (('BLOG', ''),('ABOUT', ''),) #this is the filed to use in order to set the menu items
#FEED_ALL_ATOM = 'feeds/all.atom.xml' commented by default
FEED_ALL_RSS = 'feeds/all.rss.xml'
DELETE_OUTPUT_DIRECTORY = True
GTM = False # set True if want to install Google tag manager

{
    "manifest_version": 1,
    "version": "1.0.0",
    "short_name": "", # the name of your website here
    "name": "", # the name of your website here
    "description": "", # the description of your website here
    "icons": [
        {
        "src": "theme/img/pwa512.png",
        "sizes": "512x512",
        "type": "image/png"
        },
        {
        "src": "theme/img/maskable_icon.png",
        "sizes": "512x512",
        "type": "image/png",
        "purpose": "any maskable"
        },
        {
        "src": "theme/img/pwa144.png",
        "sizes": "144x144",
        "type": "image/png"
        }
    ],
    "start_url": "/?utm_source=pwa&utm_medium=app", 
    "lang": "it-IT",
    "background_color": "#353e47",
    "theme_color": "#353e47",
    "display": "standalone",
    "orientation": "portrait-primary"
    }

author pics under "/static/img/author" folder
cat pics under "/static/img/cat" folder
projects pics under "/static/img/projects"
favicon under "/static/img/" folder
    favicon.ico # this one should not be necessary anymore
    favicon57.ico
    favicon72.ico
    favicon114.ico
    maskable_icon.png
    pwa144.png
    pwa512.png
favicon under "/content/extra/" folder
    favicon.ico
robots.txt under "/content/extra/" folder # if you need it, and you do.
privacy-policy.pdf under "/content/extra/" folder # the template has no privacy policy link anywhere. Put it where you prefer
cookie-policy.pdf under "/content/extra/" folder # the template has no privacy policy link anywhere. Put it where you prefer
.htaccess under "/content/extra/" folder

python new-html.py lang slug-of-the-post category
ex.
python new-html.py en hello-world-this-is-my-first-post coding

    <head>
        <title></title> # here there will be the slug too, change it with the title of the article (add stopwords..)
        <meta name="summary" content="" /> # add the summary used inside the blog listing pages
        <meta name="seo_desc" content="" /> # add meta description for google
        <meta name="date" content="" /> # automatic
        <meta name="tags" content="" /> # leave blank
        <meta name="category" content="" /> # automatic
        <meta name="slug" content="" /> # automatic
        <meta name="url" content="" /> # automatic
        <meta name="cover_jpg" content="" /> # automatic
        <meta name="cover_webp" content="" /> # automatic
        <meta name="cover_d1_jpg" content="" /> # automatic
        <meta name="cover_d1_webp" content="" /> # automatic
        <meta name="cover_d2_jpg" content="" /> # automatic
        <meta name="cover_d2_webp" content="" /> # automatic
        <meta name="cover1x1" content="" /> # automatic
        <meta name="cover4x3" content="" /> # automatic
        <meta name="cover16x9" content="" /> # automatic
        <meta name="thumb_jpg" content="" /> # automatic
        <meta name="thumb_webp" content="" /> # automatic
        <meta name="cat_webp" content="" /> # automatic
        <meta name="cat_jpg" content="" /> # automatic
        <meta name="alt" content="" /> # add tje alt tag for the hero image and the thumb of the article
        <meta name="authors" content="" /> # add your name. It must be the same setted inside AUTHORS dict on peliconf.py
    </head>