Skip to content

Pretty basic starter for Gatsby that covers all of the essentials. All you have to do is start typing!

License

Notifications You must be signed in to change notification settings

MartinRosenberg/gatsby-starter-hello-friend

 
 

Repository files navigation

Hello Friend

Hello Friend

Buy Me A Coffee

Features

Code highlighting

Hello Friend uses PrismJS to highlight your code. All you need to do is to wrap your code like this:

```html
// your code here
```

Supported languages

bash/shell, css, clike, javascript, apacheconf, actionscript, applescript, c, csharp, cpp, coffeescript, ruby, csp, css-extras, diff, django, docker, elixir, elm, markup-templating, erlang, fsharp, flow, git, go, graphql, less, handlebars, haskell, http, java, json, kotlin, latex, markdown, makefile, objectivec, ocaml, perl, php, php-extras, r, sql, processing, scss, python, jsx, typescript, toml, reason, textile, rust, sass, stylus, scheme, pug, swift, yaml, haml, twig, tsx, vim, visual-basic, wasm.

How to start

Clone the repo and install the dependencies:

git clone https://github.com/panr/gatsby-starter-hello-friend.git
cd gatsby-starter-hello-friend
yarn

To run the starter in development mode:

yarn dev  # gatsby clean && gatsby develop

To build and run the starter in production mode:

yarn build  # gatsby clean && gatsby build
yarn serve

How it works

It's a simple starter for blogs and personal sites. You have posts and pages directories. Posts are generated from markdown files with required fields: title, date and path. Pages can be generated from markdown files as well (with built-in navigation between them, just like in posts), but you can also generate them from JavaScript files (just like you normally do in Gatsby). If so, you should wrap your content with the Layout component. It's not required, but highly recommended.

Configuration

You can configure the starter in gatsby-config.js. Here's what you can change:

title: String,
description: String,
copyrights: String,
author: String,
logo: Shape { // you can place your own logo
  src: String, // default dir is `/static/`
  alt: String,
},
logoText: String, // change default Hello Friend logo
defaultTheme: String, // light or dark as default
postsPerPage: Number, // pagination
showMenuItems: Number, // number of visible main menu items
menuMoreText: String, // string of main sub menu trigger (not visible items from main menu)
mainMenu: arrayOf(Shape { // main menu items
  title: String,
  path: String,
})

How to contribute

If you spot any bugs, please use Issue Tracker or if you want to add a new feature directly please create a new Pull Request.

Sponsoring

If you like my work and want to support the development of the project, now you can! Just:

Buy Me A Coffee

License

This starter is released under the MIT License.

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 64.2%
  • CSS 35.8%