Artsy.github.io

Overview:

The Artsy OSS page and the blog run on top of a default Jekyll install. This article provides an overview of Jekyll and explains how to set up and run the site locally. It also covers how to add authors, write articles, and enable comments on the blog.

Features:

• Jekyll: The site runs on a default Jekyll installation.
• Installation: Provides instructions for installing the necessary dependencies, such as Ruby and v8.
• Local Development: Explains how to run the site locally using the rake serve command and mentions the need to set the PRODUCTION environment variable for generating category pages.
• Deployment: Describes how the site is automatically deployed to GitHub Pages using Circle and provides a rake command to trigger a local deployment.
• Adding an Author: Explains how to add an author by assigning a key in the _config.yml file.
• Authoring an Article: Provides instructions for creating a new post in the _posts directory, including a sample YAML header and information on adding categories. Mentions using post templates for getting started.
• Enabling Comments: Explains that comments for articles are managed using GitHub issues and provides instructions for creating an issue and attaching it to the article. Also mentions adding a comment_id attribute to the post’s YAML front matter.
• Deploying an Article: Mentions the need for a snappy tweet for each article and provides options for getting it done.

Installation:

To install the Artsy OSS site and blog, follow these steps:

1. Make sure you have a compatible Ruby version installed, e.g., 2.7.5.
2. Install v8 using Homebrew by running brew install v8.
3. Install the libv8 gem using a specific version and v8 flag: gem install libv8 -v '3.16.14.19' -- --with-system-v8.
4. Assign configuration options as instructed.

Summary:

This article provides an overview of the Artsy OSS site and blog, which run on a default Jekyll installation. It covers key features such as installation, local development, deployment, adding authors, authoring articles, enabling comments, and post-deployment tasks. The article serves as a guide for setting up and running the Artsy OSS site and blog.