Site Settings

The Site Settings section covers the basic information for your site, such as name, theme, author details and SEO options. Each set of options is divided into a separate block to make it easy to distinguish between groups of settings. This section will look at each block, and the options inside them, starting with:

Basic Settings

The first block covers the most basic options required for your site; you would have already set these options when creating your site, but here they can be modified. The available options are:

  • Site Avatar - By clicking on an icon and color, you can customize your site's avatar. This avatar is used only in the Publii backend; it will not be seen on the live website.
  • Site Name - Set the name for your site. This is used in the Publii backend, the browser tab name when visiting your site, and the site logo (if it is set to text).
  • Language - Set the date language for your site (HTML lang attribute); other theme elements may be translated via a separate language file (see the Translate Theme section of this guide for more info).
  • Enable Spellchecker - Publii includes a spellchecker (OS spellchecker for MacOS and Hunspell on Windows and Linux) to help you catch errors as you write; when enabled, unknown words or acronyms will be underlined in red. Right-click on a word to see alternative spelling suggestions for the word. Toggle this option off to disable the spellchecker. On Windows and Linux the spell checker language is set based on the language of the site (see above), for MacOs is set automatically.
  • Current Theme - Sets the current theme for your site. Choose from a previously-installed theme, or choose a theme from the Install and Use section to download a new theme from the Publii marketplace.

Advanced Options

Content's a big part of a website's success, but there's plenty of other areas that deserve attention. Publii includes a full set of advanced options covering SEO, social media and custom code to give you the power to fine-tune to your heart's content. To reach these options, click on the Site Settings option in the left-sidebar, then scroll down to the third group of options on the settings page:

Site Settings SEO

Let's look at the options in this section one-by-one.

SEO

SEO (Search-Engine Optimization) is a method for maximizing your search engine ranking; options in this area will help you better define your site for better search hits.

  • Noindex Website - When this option is enabled search engines are prevented from indexing your entire site; this will discourage your content appearing in searches.

Frontpage

  • Page Title - The page title, also called a Meta title, is used by search engines to better match searches to your site. The page title will also be used in search engine results rather than your frontpage URL or plain sitename, so you can control how your site is presented in Google, Yahoo etc...
  • Meta Description - Meta descriptions work alongside Page Titles to give search engines a clearer idea of what your frontpage content is about, and will be used in search engine results along with the page title to give a clearer overview of your site to users.
  • Meta Robots - These options tell search engines how to treat your frontpage content; Index means they'll document the frontpage/tag/author pages and make them available in searches, while Follow tells them to follow links on the frontpage, tag or author pages. Conversely, noindex and nofollow prevent search engines from documenting your site or following links.
  • Disable Hompage Pagination Indexing - When enabled, files that created paginated content (that is, content that is spread over multiple separate pages) are not included in the sitemap, and have both noindex and nofollow tags added, so search engines will not crawl and index them.

Post Page

  • Page Title - As with the Page Title for the frontpage, this provides search engines with a title for your post listing page to be displayed in search results.
  • Meta Description - Just like the Meta Description for the frontpage, this provides information about the content of your post pages for use in searches and search results.
  • Hide custom excerpts on post pages - If this option is enabled your post pages won't display text which is placed above the "Read more" element in the post editor.

Tags List Page

  • Page Title - As with the Page Title for the frontpage, this provides search engines with a title for your tags page to be displayed in search results.
  • Meta Description - Just like the Meta Description for the frontpage, this provides information about the content of your tags page for use in searches and search results.
  • Meta Robots - Sets whether tags page are indexed and links followed by search engines.

Note: The Tags Page is only available if your theme supports it. Otherwise, the settings for this page will not be available.

Tag Page

  • Page Title - As with the Page Title for the frontpage, this provides search engines with a title for your tag listing page to be displayed in search results.
  • Meta Description - Just like the Meta Description for the frontpage, this provides information about the content of your tag pages for use in searches and search results.
  • Meta Robots - Sets whether tag pages are indexed and links followed by search engines.
  • Display Tags w/o Posts - If enabled, any tags that do not have any posts assigned to them will still have their subpages created and will appear on the tag list on the website.
  • Disable Tags Pagination Indexing - As with the frontpage, if this option is active then paginated content links (content over multiple pages) will not be indexed or followed by search engine robots.
  • Disable Tags Pagination - If toggled on, pagination files will not be generated at all.

Author Page

  • Page Title - As with the Page Title for the frontpage, this provides search engines with a title for your author page to be displayed in search results.
  • Meta Description - Just like the Meta Description for the frontpage, this provides information about the content of your author pages for use in searches and search results.
  • Meta Robots - Sets whether the author page is indexed and links followed by search engines.
  • Display Authors w/o Posts - When this option is enabled authors created on your site that do not have any posts yet will still have subpages generated for them and will appear on the list of site authors.
  • Disable Authors Pagination Indexing - If enabled, pagination files (for content across multiple pages) will have the noindex and nofollow attributes added to them.
  • Disable Authors Pagination - If toggled on, pagination files will not be generated at all.

Error Page

  • Page Title - As with the Page Title for the frontpage, this provides search engines with a title for your error page to be displayed in search results.
  • Meta Description - Just like the Meta Description for the frontpage, this provides information about the content of your error page for use in searches and search results.
  • Meta Robots - Defines whether the error page is crawled and indexed by search engines; see the Frontpage Meta Robots option above for more information.

Search Page

  • Page Title - As with the Page Title for the frontpage, this provides search engines with a title for your search page to be displayed in search results.
  • Meta Description - Just like the Meta Description for the frontpage, this provides information about the content of your search page for use in searches and search results.
  • Meta Robots - Sets how search engine robots should treat your search page; whether it should be crawled and indexed or not.

URLs

URLs are the addresses used to visit your website, and Publii includes options to fine-tune the appearance and hierarchy of your URLs.

  • Use pretty URLs - When enabled site URLs will not display filenames such as .html in the URL.
  • Always add index.html in URLs - Use this option if you cannot enable loading index.html files by default when a directory on your server is opened.
  • Tag Prefix - Text entered here will appear before the tag slug in the URL of your tag pages e.g. www.yoursite.com/tag_prefix/tag_slug/.
  • Author Prefix - Text entered here will appear before the author slug on your author pages e.g. www.yoursite.com/author_prefix/author_slug/
  • Pagination Phrase - Text entered here will appear before page numbers when browsing to the second or later pages of post listings e.g. www.yoursite.com/pagination_phrase/2.
  • Error Page - Defines the name of your error page. Defaults to error.html.
  • Search Page - Defines the name of your search page. Defaults to search.html.

Sitemap

A sitemap is a list, usually in XML format, detailing the hierarchy of your site from the frontpage down. It can be used by both search engines and regular users so its worth having, and Publii can take care of it automatically. The options in this section are:

  • Create XML Sitemap - Ticking this will allow Publii to create a sitemap for your website.
  • Sitemap Content - Here you can decide which parts of your site you want included in the sitemap, with toggles covering Tag PagesAuthor PagesHomepage Pagination, and External Images. Enable or disable each section that applies as needed.
  • Excluded Files - If you wish to exclude specific files from the sitemap, you can add them in this field.

Open Graph

Despite the rather technical name, Open Graph Tags are simply a way to customize how your articles or page links will look like when shared on social networks like Facebook. It means your page links will be more informative and much more likely to get someone to click on the link. The options in this section are:

  • Generate Open Graph tags - Set whether Open Graph tags are generated or not; generally, you'll want to leave this active for improved social media sharing.
  • Fallback image - Click Choose file or drag and drop an image onto this field to set the fallback image; this is the image that will be used in social media previews if no other is available e.g. from the shared post. If left blank, the site logo will be used as a fallback by default.
  • Use the page title in metatags - If this option is enabled then the og:title and twitter:title metatags will use the page title as their value, rather than the post title, tag or author name.
  • Facebook App ID - This ID is required to enable Facebook's functionalities with Open Graph on your site; if you have not yet created an App ID, you may do so using Facebook's guide.

Twitter Cards

Twitter Cards are very similar to Open Graph Tags in that they customize how your links will look when shared, but obviously Twitter Cards is specific to Twitter! The options in this section are:

  • Generate Twitter Cards - Enables or disables Twitter Cards for your site.
  • Twitter Username - Enter your Twitter Username in this section; it's required when generating the cards.
  • Card Types - You can choose between a standard card or one with a large image; both function exactly the same mechanically.

AMP

A fairly new development in the online world, AMP (Accelerated Mobile Pages) help to make your content easier to reach for mobile users when finding your content via Google or other participating search engines and providers. With AMP, mobile-optimized versions of your webpages are created that are automatically sent to users on smaller, less-powerful devices to optimise load-times.

The options available are:

  • Enable AMP - Sets whether your Publii website uses AMP or not.
  • Theme Primary Color - Sets the base color of the AMP-version of your theme; don't worry if you don't know hexadecimal color codes, as when you click on the option a color-picker will open so you can just click on the color your want.
  • Fallback Logo Image - Some mobile browsers don't support all content types; a fallback logo image is an alternative version of your logo image that uses a simpler, more widely-supported format as a fallback option. It's not necessary for this option to be completed, but if you have a fallback version prepared it may be added here.
  • Google Analytics Tracking ID - If your site uses Google Analytics to track how your site performs, enter the Tracking ID provided by Google in this field to include tracking in your AMP site.
  • Enable Sharing Buttons - Enabling this option will add social media share buttons to your mobile pages; you can decide exactly which buttons should be included further down the section.
  • Enable X Share Button - Once sharing buttons are enabled a new set of options will load with switches to enable/disable share buttons for each site. Buttons are available for Facebook, Twitter, Pinterest, LinkedIn, Tumblr and WhatsApp.
  • Facebook App ID - If you enable the Facebook share button then you'll see another new option for the Facebook App ID; each website that wants to use Facebook buttons must have an associated app ID. Learn more on this step, and how to get your app ID with Facebook's guide.
  • Footer Text - Text entered in this section will appear in the footer of the AMP version of your site.

GDPR

The GDPR section controls the GDPR cookie popup, which is used to obtain consent from users to receive cookies. Under the EU General Data Protection Regulation (GDPR), users will need to consent individually to each type of cookie that collects personal information; you can discover more about the GDPR and how to prepare your website for it in our guide to making your website GDPR-compliant on the Publii blog.

The options available in this section are:

  • Add GDPR cookie banner - When enabled, the cookie popup will appear on your site.

Once the popup is enabled, the following additional options will be appear to allow you to configure the popup:

  • Title - Set the title that will appear at the top of the cookie popup.
  • Description - Provide a description; this section should explain the type of cookies your website uses, and ask users to tick any cookie types that they agree to receive.
  • Link label - The cookie banner will need to link to a privacy policy page; you can set the text for this link in this field.
  • Privacy Policy URL - Sets whether the privacy policy link points to an internal or external URL.
  • Privacy policy page - Only available if the Privacy Policy URL option is set to Internal. Sets which page the privacy policy link above points to; choose the page from the list, or type the name of the page into the field to filter results if you already have a lot of posts. The GDPR requires that any sites that collect personal data provide a privacy policy explaining which data is collected, why it is collected, and how it will be used and stored; we recommend creating the privacy policy page as a hidden post that will not appear in listings, but can be linked to in the cookie popup.
  • Privacy policy page URL - Only available if the Privacy Policy URL option is set to External. Enter the URL for your privacy policy into this field.
  • Save button label - Sets the text for the save button in the cookie popup.
  • Open Popup window by - Defines the type of cookie popup that appears; this should be left as the default Badge for most users, but advanced users can define a Custom link for their own popup, or Badge & custom link to use both.
  • Anchor link - Only available if the previous option is set to Custom link or Badge & custom link. Defines the link for the cookie settings.
  • Badge label - Sets the title text of the cookie popup badge, which will appear in the bottom corner of the window for users to click and open.
  • Cookie groups - This section allows you to create and manage cookie groups that you can add your website's scripts to, which will then appear as tickboxes for users to select in the cookie popup. You may set:
    • Group name, which is how the tickbox will be labeled in the cookie popup,
    • Group ID, which is the name that will be used in the Type attribute of your scripts to assign it to a group,
    • State - useful if you want to set a group of cookies enabled by default.
    More information on how to add your scripts to a particular group can be found in the how to add a script to a cookie group section of this guide.

Adding and Deleting groups

If you are using a script, or feature, on your Publii website that uses cookies that collect personal information, then they will need to be added to the cookie popup under the correct group. When Publii is installed there are three basic groups already created:

  • Required - Scripts in this group are needed for the website to work correctly, or don't require separate consent. For example, the basic settings of Google Analytics does not collect any personal data, so no action needs to be taken and it can be considered 'required'.
  • Functionality - This group is for scripts that provide a feature on the site, but require some personal data to do so; users will need to agree to accept these cookies before they can use this feature. An example of a script of this type would be Disqus, which powers the comment system available in Publii; it needs cookies to identify the user and allow them to post comments.
  • Analytical - This group covers any cookies that collect personal data for the purposes of tracking user behaviour or location. If using more advanced versions of Google Analytics (other than the basic settings) or other analytical tools on your site, then they should be included in this group.
  • Marketing - This group is for any cookie that collects data to be used for the purposes of marketing and advertising. Publii doesn't include any tools that would fall into this category, but there are many third-party vendors who provide such services.
Adding or deleting a group

If you need to create additional groups for your cookies, then you can do so by clicking the Add group button at the bottom of the list of groups. This will create an extra row in the list where you can set an name and ID for the group. Remember to use the ID as the value for a Type attribute in the script code you want to add to this group (details on how to do this is covered in the next section). To delete a group, simply click the red "X" next to the group you wish to delete.

Adding a script to a group

Once you have your cookie groups set-up, you will need to add each 'script', which can basically be thought of as a block of code that powers a particular feature on your site, that uses cookies to collect or store personal data to the group. This requires some additional steps compared to other features as you will need to modify the theme's code to add the group name. A guide for doing this can be found in our developer documentation; How to make your theme GDPR-compliant. IF you're having trouble following that guide, then you may use the following as an example; these steps show how to add a "Type" attribute to the Disqus script, which powers the comment system in Publii and uses cookies to identify users and allow them to post:

  1. Make sure that your theme has been updated; older versions of the theme do not include the extra little bit of code that allows scripts to be added to the cookie popup.
  2. Take a note of the group ID of the group you want to add Disqus to; we will use the default "Functionality" group, which uses the "functions" group ID.
  3. We need to open the file that contains the script we want to add to the popup, so we'll need to open our Publii/sites/site-name folder, where site-name if the name of your site (the location is set in the Global Setting, if you're not sure where you keep them).
  4. Now we need to get to the theme file that is being used by your site; continue navigating to the input/themes/theme-name folder, where theme-name is the name of your current theme.
  5. This folder contains all the files for the theme your current site is using; now open the partials folder and you'll find separate files containing the different scripts that provide various functions on your site. Use any text or code editor (you can use something specifically for code editing such as Sublime Text, but even Notepad will do) to open the disqus.hbs file.
  6. Now to add our Type attribute; in the second line of the disqus.hbs file is an opening <script&rt; tag; we must modify this tag to include the following type attribute:
    <script type="{{ gdprScriptBlocker "functions"}}"></script>

    The {{ gdprScriptBlocker }} helper does all the heavy work of sorting the script and blocking it if it is not consented to by the user, and the "functions" text assigns it to the "Functionality" group's ID.

  7. Save the changes to the file, and you're done.

Note: Changes made to the theme files in this manner will be overwritten should you later update the theme, so the process will need to be repeated. More advanced users can take advantage of file overrides to apply a more permanent change, if required.

Website Speed

Publii's static webpages are already blazing-fast at loading, but it's always nice to have a few more little options for those extra speed gains! The options here are:

  • Enable HTML Compression - Enabling this option will compress the HTML code used for your site; for the most part you'll be able to leave this enabled and reap the benefits, but if advanced users want to disable it, they can.
  • Enable CSS Compression - The same as above, but this time compressing the CSS code rather than the HTML. Leave this enabled if you're unsure, as it'll give a little boost to your load times.
  • Remove HTML Comments - If enabled, comments in HTML (which are not displayed on a live site, but are used to highlight or explain things to people reading the source code) will be removed during the compression process.
  • Enable Media Lazy Load - When enabled, the native lazy loading will be used to lazy loads images, videos and iframes.
  • Enable Responsive Images - If enabled, Publii will deliver different sized images at different screen resolutions depending on breakpoints defined through config.json
  • Version parameter - When enabled, the user's browser cache of your site will be marked to be refreshed whenever the site is updated. If enabled, this may generate more files to be uploaded on sync.
  • Responsive Images Quality - This option sets how much images should scale. That is, when a photo is shown on a smaller screen, how much should the quality be reduced, since on a smaller screen a lower quality won't be as noticeable and will reduce file size for faster loading. The default is set to 60%, but feel free to play around with this option and find the setting that works for you.

RSS/JSON Feed

RSS and JSON Feeds are a way for your content to be syndicated and shared far beyond your site, encouraging new users to visit. For many people web feeds like this are an important way of staying on top of new content, with JSON feeds being the latest development in this area. The options in this section are:

  • Enable RSS feed - When turned on, an RSS feed will be generated for your site.
  • Enable JSON feed - When enabled, a JSON feed will be generated for your site.
  • Feed title - Sets the title of your feed.
  • Show full text - If this option is enabled then your website articles sent via the feed will include the full text, so users won't be required to visit your site for the complete article.
  • Show only featured posts - When this option is enabled, the RSS feed will be generated with posts marked as featured.
  • Exclude featured posts - When this option is enabled, the RSS feed will be generated without posts marked as featured.
  • Number of posts in peed - Set how many articles people can access from the webfeed at once; default is set to 10.
  • Show featured image - When this option is enabled the Featured Image for each shared post will be included in the feed.

Posts Listing

The options is this section give you finer control over how your frontpage post ordering. The available options are:

  • Posts Order By - Set how the posts on the frontpage are ordered; choose from Post Creation DatePost TitlePost Modification Date, or Post ID.
  • Posts Ordering - Sets whether the posts follow ascending or descending order.
  • Featured Posts Order By - Sets the ordering style of featured posts on the frontpage; the same options are available as with the standard post ordering.
  • Featured Posts Ordering - Sets the ordering of featured posts to ascending or descending.
  • Hidden Posts Order By - Sets the ordering style of hidden posts in post listings.
  • Hidden Posts Ordering - Sets the ordering of hidden posts to ascending or descending.
  • Related Posts Selection Mechanism - Sets how Publii should find related posts; 
    • Use Only Titles will look for similiarities in other posts' titles to the current post. 
    • Use Only Tags will look for similarities in the tags used in other posts to the current post. 
    • Use Titles and Tags will combine both methods. 
  • Related Posts Ordering - Sets the ordering of related posts to ascending or descending by ID, or can be set to Random.
  • Related Posts Options - When enabled, related posts will be taken from all tags. When disabled, related posts will only be generated from the same tags as the current post.

Editors

This section contains elements that extend the capabilities of the editors.

  1. WYSIWYG editor - this option defines which elements will remain in the edited text when the editor saves. You can use this to extend the returned HTML. The default rule set for this option is a combination of the HTML5 and HTML4 specifications.
    For example: adding v-select[*], v-dropdown[*] will extend the list of allowed tags with custom v-select and v-dropdown tags with any attributes.
  2. Code editor (CodeMirror) - disable or enable an auto-indent and specify the indent size for the CodeMirror HTML source code editor.