Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.
/ engineering Public archive

Jekyll website and blog showcasing open source projects by GoDaddy employees

Notifications You must be signed in to change notification settings

godaddy/engineering

Repository files navigation

GoDaddy Engineering Blog

Source code for GoDaddy's GitHub page at godaddy.github.io. Created and maintained by our engineers, this site contains blog posts about the technology and tools we're using at GoDaddy to create software which empowers small businesses around the world to build and market their digital identities.

Development

Develop in a fork of the repository. You can use the GitHub 'Fork' button to create your own fork.

Clone your forked repository.

git clone [email protected]:YOUR_USERNAME/godaddy.github.io.git

Ensure you have Ruby 2.7.1 installed. If you're using RVM you can do this with

rvm install 2.7.1

Install project dependencies.

bundle install

Build the site on the local preview server.

bundle exec jekyll serve

If building the site on a Windows box you may need to use the --force_polling option as shown below. To learn more see here.

bundle exec jekyll serve --force_polling

The local server listens on http://localhost:4000 by default.

To distribute a preview of your changes, enable GitHub Pages by going to the Settings of your forked repository and set the Source to the master branch. Within a minute you should be able to access it at https://YOUR_USERNAME.github.io/godaddy.github.io.

Theme Front Matter

In addition to the default page front matter, the following variables can be utilized:

Pages

Variable Description
hide Prevents the page from being included in the site navigation
order Controls the page order for top navigation items
slug Used to create unique body class selectors
title Used in the document title, Open Graph and Twitter meta, site navigation, and masthead

Posts

Variable Description
authors A list of authors who contributed to the post
excerpt A brief description of the post, used in social previews and meta tags
cover A featured image for the blog post
options A list of features to enable: full-bleed-cover will render a full-width cover photo above the post title