Joan Mira's personal website
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
content
design
scripts
src
static
.editorconfig
.eslintignore
.eslintrc.json
.gitignore
.prettierrc
.travis.yml
LICENSE
README.md
gatsby-browser.js
gatsby-config.js
gatsby-node.js
package-lock.json
package.json
postcss.config.js
yarn.lock

README.md

PRs Welcome Build Status

Joan Mira's personal website

Live website

Powered by GatsbyJS, ReactJS and Github.

Features

  • Easy editable content in Markdown files (posts, pages and parts)
  • CSS with styled-jsx and PostCSS
  • SEO (sitemap generation, robot.txt, meta and OpenGraph Tags)
  • Social sharing (Twitter, Facebook, Google, LinkedIn)
  • Images lazy loading and webp support (gatsby-image)
  • Post categories (category based post list)
  • Full text searching (Algolia)
  • Contact form (Netlify form handling)
  • RSS feed
  • 100% PWA (manifest.webmanifest, offline support, favicons)
  • Google Analytics
  • App favicons generator (node script)
  • Easy customizable base styles via theme object generated from yaml file (fonts, colors, sizes)
  • React v.16.3 (gatsby-plugin-react-next)
  • Components lazy loading (social sharing)
  • ESLint (google config)
  • Prettier code styling
  • Webpack BundleAnalyzerPlugin

Prerequisites

If you do not have Gatsby Cli installed yet, do it first.

npm install --global gatsby-cli

More information on GatsbyJS.org

Getting started

Clone the repository.

Go into the newly created directory and run

gatsby develop

to hot-serve your website on http://localhost:8000 or

gatsby build

to create static site ready to host (/public).

To deploy to Github pages, just Instructions

npm run deploy
External services

The starter uses external services for some functions: comments, searching, analytics. To use them you have to secure some access data. All services are free to use or have generous free tiers big enough for a personal blog.

Create an .env file like below in the root folder. Change ... placeholders with real data.
By default, your .env file will be ignored by git. Remove .env from .gitignore in order to be able to push the file to your repository.

GOOGLE_ANALYTICS_ID=...
ALGOLIA_APP_ID=...
ALGOLIA_SEARCH_ONLY_API_KEY=...
ALGOLIA_ADMIN_API_KEY=...
ALGOLIA_INDEX_NAME=...

Windows users

You should take a look at this: Gatsby on Windows

Authors

Contributing

  • Fork the repo
  • Create your feature branch (git checkout -b feature/fooBar)
  • Commit your changes (git commit -am 'Add some fooBar')
  • Push to the branch (git push origin feature/fooBar)
  • Create a new Pull Request