-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit d6d3ccd
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
<div align="center"> | ||
<p><img src="https://d.pr/free/i/FDUErn+" alt="Flightdeck Logo"></p> | ||
<h1>Flightdeck-Go</h1> | ||
<h4>An opinionated starter project for <a href="https://gohugo.io/">Hugo</a> that takes advantage of Hugo's built in <a href="https://gohugo.io/hugo-pipes/" title="hudo's asset pipeline">asset pipeline</a>.</h4> | ||
|
||
[![release](https://img.shields.io/github/release/ginfuru/Flightdeck-go.svg?style=for-the-badge&logo=github&logoColor=white&colorA=101119&colorB=6D57FF)](https://github.com/ginfuru/Flightdeck-go/releases/latest) [![hugo](https://img.shields.io/badge/Hugo-v0.66.0+-373277.svg?style=for-the-badge&logo=hugo&logoColor=white&colorA=101119&colorB=7273D6)](https://github.com/gohugoio/hugo/releases/latest) [![license](https://img.shields.io/badge/License-MIT-373277.svg?style=for-the-badge&l&logoColor=white&colorA=101119&colorB=42557B)](https://github.com/ginfuru/Flightdeck-go/blob/master/LICENSE) | ||
|
||
</div> | ||
|
||
## Prerequisites | ||
Make sure that Hugo is installed by checking out the [Quick Start Guide](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo) on the Hugo docs... make sure you're running the extended version. | ||
|
||
## Usage | ||
First things first, clone this repo: | ||
|
||
```shell | ||
git clone git@github.com:flight-deck/Flightdeck-go.git MY-HUGO-PROJECT && cd MY-HUGO-PROJECT | ||
``` | ||
|
||
Then run the Node commands | ||
```shell | ||
yarn | ||
yarn start | ||
``` | ||
**OR** | ||
|
||
```shell | ||
npm install | ||
npm start | ||
``` | ||
|
||
|
||
> ### Disclaimer | ||
> Flightdeck is a project scaffold and workflow for Hugo sites and apps. It **IS NOT**, a Hugo theme and **CANNOT** be dropped into the `/themes` directory. | ||