Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blinkk/forestry-rtest
https://github.com/blinkk/forestry-rtest
Last synced: about 4 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/blinkk/forestry-rtest
- Owner: blinkk
- License: mit
- Created: 2019-11-08T19:08:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-11-12T22:03:16.000Z (about 5 years ago)
- Last Synced: 2024-11-14T08:31:45.177Z (2 months ago)
- Language: CSS
- Size: 63.2 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Brevifolia
## About
[](https://app.netlify.com/sites/brevifolia-hugo-forestry/deploys)
Brevifolia is minimalist blog starter to get you going using [Forestry](https://forestry.io/) with [Hugo](https://gohugo.io/). See the demo [here](https://brevifolia-hugo-forestry.netlify.com/)
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](https://github.com/EmielH/tale-hugo). The ammended styles were coded & designed by yours truly, using [scss](https://sass-lang.com/) and the [bem](http://getbem.com/) naming convention. The font used is [Work Sans](https://fonts.google.com/specimen/Work+Sans).
## Quick Setup
#### *Import directly to Forestry*
#### *Set-up Locally*
In your terminal, navigate to where you would like this blog to live, then run
```bash
#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](https://forestry.io/docs/editing/) all of the content via the sidebar.
You can add new blog posts, [data files](https://forestry.io/docs/editing/data-files/), or entire pages and sections to fit your needs. You can also [customize how media](https://forestry.io/docs/media/) is handled, by configurating gitLFS, Cloudinary, S3, or Netlify Large Media.
You can set up a [remote admin](https://forestry.io/docs/editing/remote-admin/) for content editors to log in directly to yoururl.com/admin to make content updates.
### Instant Previews
The [instant preview](https://forestry.io/docs/previews/instant-previews/) 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
[](https://app.netlify.com/start/deploy?repository=https://github.com/kendallstrautman/brevifolia-hugo-forestry)
[Netlify](https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-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.