This section will go over the various theme configuration options, though you will want to wait until finishing setup to set some of them.
To access theme configuration, go to the Themes section and click on the Tutorial theme.
A space has been provided for the link to a git repository if using Git Sync (strongly recommended). You will probably want to fill this out after setting up the plugin.
user/themes/tutorial/css/ contains an option to add an outline to an added logo link when a user hovers over it (or when it receives focus). You can uncomment this and add it to
custom.css if you want to try it out.
This theme is set up to work with Google Analytics. If you are not planning to use Google Analytics, you can toggle this option off and ignore the rest of this section. If you are using Google Analytics, an opt out/opt back in button will be added to the footer of each page. You can always come back and change this later.
If you would like to replace this text, disable the default policy and follow the instructions further down for creating custom footer text.
Provide the organization or other entity creating/maintaining the tutorial. You can also provide a link to the entity's website/homepage.
Provide the license you will be sharing the tutorial under. If unsure, we recommend
Creative Commons Attribution-ShareAlike 4.0 International License. You will also want to provide a link to the full text of the license and possibly a link to an image for the license. For example: CC BY-SA 4.0 license, CC BY-SA 4.0 image.
If using Git Sync, you may want to provide a link and the name of the hosting service (default GitHub) so viewers can access the repository.
A folder called modules with a page called footer has been provided if you wish to include custom footer text. The footer page currently has no content, but any added content will be displayed in the footer on all pages. Neither the modules folder nor the footer page are routable, so they will not appear in the main navigation or the top/bottom page navigation.
If you do not have the modules folder and footer page, you can set them up manually.
To prevent overwriting your changes, the theme does not include a file for custom CSS. Instead, you can add code using this plugin. The theme file
theme.css has a number of options that you may want to copy over to modify. It is heavily commented to make it as easy as possible to understand what the code is doing, even if you are not familiar with CSS. Most of the options in this file are color choices.
If you are modifying colors, please remember to check for color contrast! WebAIM provides an excellent color contrast checker that I recommend using.
Note: These instructions are for Git Sync version 2.1.1
Note: These instructions walk through setting up Git Sync with GitHub, but you can use another hosting service if you prefer.
Since Git Sync was last updated (as of v.2.1.1), GitHub has changed the default branch for all new repositories from master to main. You will need to manually change this back to prevent issues with the plugin. The easiest way to do this is to go the repository Settings > Branches and rename main to master.
Important: Do not skip this step or the plugin will not work.
.gitto the end.
Note: Every time you enter the Git Sync plugin configuration page, it will automatically fill out the Git Password or Token option with something else. If you are changing the settings at any time, make sure you have changed this back to the correct password/token before saving, or future syncs will fail. Any time you exit the page (even right after saving) you will need to continue without saving.
The plugin will add a button just above Dashboard in the side navigation of the admin panel. You can click this at any time to synchronize with your repository.
If you have set the plugin up to synchronize on page save, you may occasionally receive a complicated error when trying to save after adding several images. In this case, try saving the page again and see if it syncs successfully.