Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 4.19 KB

README.md

File metadata and controls

74 lines (51 loc) · 4.19 KB

Brevifolia

About

Netlify Status

Brevifolia is minimalist blog starter to get you going using Forestry with Hugo. See the demo here

This blog is statically generated by Hugo. It is preconfigured to work with Forestry as a way to manage your content. Forestry makes changes by editing markdown or data files, uploading media to the correct directory and committing these updates to your repo directly.

The Hugo version of this Brevifolia starter was built upon the already well-known Tale Theme. The ammended styles were coded & designed by yours truly, using scss and the bem naming convention. The font used is Work Sans.

Quick Setup

Import directly to Forestry

Import this project into Forestry

Set-up Locally

In your terminal, navigate to where you would like this blog to live, then run

#clone the repo
git clone [email protected]:kendallstrautman/brevifolia-hugo-forestry.git

#navigate to the directory
cd brevifolia-hugo-forestry

#install dependencies & run dev server with yarn 
yarn install
hugo serve

#or with npm 
npm install
hugo serve

A new browser window should open with the dev server running or you can navigate to localhost:1313

Project Structure

  • Site-level configuration is stored in config.toml, this is required in the root for Forestry to setup the project.
  • Edit styles via themes/assets/scss/tale/...
  • content/...contains all your markdown blog posts, pages & data files (e.g. authors list, info page data).
  • Images and media are uploaded to static/images/...
  • Templates can be edited in themes/layouts/...

Using Forestry as your CMS

The .forestry directory contains all the settings information and frontmatter configuration to allow Forestry to setup the sidebar structure and editing capacity for this blog. After importing this blog into forestry, you can access and edit all of the content via the sidebar.

You can add new blog posts, data files, or entire pages and sections to fit your needs. You can also customize how media is handled, by configurating gitLFS, Cloudinary, S3, or Netlify Large Media.

You can set up a remote admin for content editors to log in directly to yoururl.com/admin to make content updates.

Instant Previews

The instant preview method spins up a development server for a long-lived preview that can quickly respond to content updates. When using instant previews, your preview command should be the develop command. The development server spawned by this command should be available over port 8080, and bind to 0.0.0.0.

Deploy Options

Deploy to Netlify

Netlify is a great way to easily deploy sites. There's no special setup you need to do with Forestry to deploy with Netlify. When Forestry makes commits to your repo, Netlify will auto-trigger a rebuild / deploy when new commits are made.