Skip to content

Latest commit

 

History

History
136 lines (74 loc) · 6.36 KB

README.md

File metadata and controls

136 lines (74 loc) · 6.36 KB

Hyde

Hyde is a brazen two-column hugo theme based on the Jekyll theme of the same name. It pairs a prominent sidebar with uncomplicated content.

Hyde screenshot

First Steps

1. Import

To give you a running start this installation puts a fully configured starter repo into your Account and imports it into the Forestry Content Manager.

Forestry Starter-Kit:

Import this project into Forestry

You've now successfully installed your Hyde Theme in a Hugo project.

There's a few more settings we need to customize before you can get started.

2. Deployment

Currently your site is only visible to you but there's a few options to quickly make your site available to the world.

The easiest option in our opinion is Netlify. It's quick to setup and relatively easy to maintain.

  1. Go to https://app.netlify.com/start
  2. Connect your Git provider and provide Netlify access to your repository (e.g. username/hyde)
  3. Select and Click on your repository
  4. Enter your build settings.
    • Build Command: hugo
    • Publish Directory: public
  5. Add advanced build settings as a new variable.
    • Key: HUGO_VERSION Value: 0.42
  6. Click on Deploy Site

  1. Lastly copy your URL (e.g. https://something-something-123456.netlify.com/) and add it as your URL in your Site Configuration.

The more powerful option is deployment to AWS and makes sense if you have experience with S3 and Cloudformation. You can find detailed documentation and a deployment template here.

For other deployment options please check out our list here (including Webhooks, FTP/SFTP and Github Pages).

3. Advanced Settings

Themes

Hyde ships with eight optional themes based on the base16 color scheme. Apply a theme to change the color scheme (mostly applies to sidebar and links).

Hyde in red

There are eight themes available at this time.

Hyde theme classes

To use a theme, go to Site Configuration -> Additional Settings -> Theme -> Add one of the theme names above.

To create your own theme, look to the Themes section of included CSS file. Copy any existing theme (they're only a few lines of CSS), rename it, and change the provided colors.

Reverse layout

Hyde with reverse layout

To reverse page orientation activate Reverse Layout in Site Configuration -> Additional Settings.

Commentary with Disqus

You can optionally enable a comment system powered by Disqus for your posts. Simply add your Disqus Shortname in Site Configuration -> Additional Settings -> Disqus Shortname.

If you don't have a Disqus Account you can sign up for an account here.

Google Analytics

Google Analytics can be enabled by assigning your tracking code to Site Configuration -> Additional Settings -> Google Analytics Tracking Code.

If you don't have a Google Analytics Account you can sign up for an account here.

4. Editing in Forestry

Your site is completely editable in Forestry. The Hyde theme is a simple responsive blog completely based on posts and a sidebar menu.

Creating and Editing A New Page/Post

Pages and Posts are separated into two different categories.

To create a new page or post click on Create New and select Post (or Page depending what section you are in). Enter a title and click Create to proceed to the editor.

On the left side you'll find general settings (e.g. title, subtitle, date etc.) and on the other side you have access to the Forestry Editor. The toolbar at the bottom of the editor will help you format and more easily navigate the editor.

Add and Edit the Sidebar

To add new links and edit existing ones navigate to Menus and click on add link or click on the settings wheel to edit existing links.

You are also able to reorder or remove existing links.

Preview

You can preview any post or page to see what it looks like before you publish your changes. Simply click on in the top-right corner of your editor.

Publish

All new posts/pages start out as draft. To publish a post/page you'll have to turn Draft to OFF and click on Save. If you've set up the site as outlined in the Deployment section, Forestry will no build your site and your hosting provider (Netlify, AWS, etc.) is going to update your website shortly.

More Information on Editing with Forestry here
The full documentation for Developers using Forestry can be found here


Author

Mark Otto

Ported By

Steve Francia

License

Open sourced under the MIT license.

<3