Notebook theme for WordPress
This is a simple, translation-ready WordPress theme for keeping notes. It is currently in use on piperhaywood.com.
Installation
The compiled theme is in /notebook-ph. This directory can be zipped and uploaded in the WordPress theme management page, or the directory can be manually uploaded via cPanel or FTP. For further instructions, see the WordPress documentation page Using Themes.
Description
Post titles are purposefully obscured. For Standard posts (longer format writing), titles are displayed in the body of the content. For all other formats (aside, image, quote, etc.), titles are only displayed on the post permalink as a breadcrumb.
The theme makes use of the Infinite Scroll library by Metafizzy under the open source license GPLv3. The theme uses Prism.js for syntax highlighting.
This theme is optimised for use with the plugins Classic Editor, GA Google Analytics Pro, and Related Posts By Taxonomy (though they are not required). Other recommended plugins include VaultPress, Yoast, and most importantly Wordfence.
Theme options
In the WordPress Customiser, you can adjust:
- The short site title that is displayed in the header on archive pages
- The copyright text displayed in the menu
- The text displayed at the end of infinite scroll
- A blog introduction
- Whether or not the theme credit is displayed
- Whether or not the author is displayed
- Whether or not the theme should use the rainbow colour scheme
Shortcodes
The shortcode [notebooksearch] displays a search form.
The shortcode [notebookindex] displays an alphabetical index of terms. The Index shortcode can be passed attributes that modify the included taxonomies, the post count threshold, and whether or not year archive links are displayed. For example, [notebookindex taxonomy="category" years="false" count="2"] will pull through only categories with a post count of at least 2 and no year archive links. If no attributes are passed to the notebookindex shortcode, then these default attributes will be used: [notebookindex taxonomy="post_tag, category, post_format" years="true" count="1"].
The shortcode [notebooklist] displays a chronological list of posts.
Development
To set this repo up, install WordPress in a separate directory using this multi-environment wp-config.php gist if useful, then symlink the theme folder /notebook-ph within this repo in to your WP site’s /wp-content/themes directory. You can do this with multiple WordPress installations, which can be useful for testing styles against different content. I use this with one WordPress installation that reflects piperhaywood.com and another that uses WordPress’s theme testing database.
Once you have the WordPress installation set up and the theme symlinked, run npm i from the root of this repo to install dependencies. Run gulp to build the theme or gulp dev for development. The command gulp dev will compile the files and then use BrowserSync for live reloading. To set a BrowserSync proxy other than the default localhost:8888, run gulp dev --proxy custom-proxy (replace custom-proxy).