From 457aec28f6bccb18883ee53dc5634509c7b21435 Mon Sep 17 00:00:00 2001 From: Dean Attali Date: Mon, 27 Apr 2020 11:00:01 -0400 Subject: [PATCH] move features to be the first section in readme --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 20e9002..a4fc1be 100644 --- a/README.md +++ b/README.md @@ -20,17 +20,33 @@ ### Table of contents +- [Features](#features) - [Build your website in 3 steps](#build-your-website-in-3-steps) - [The easy way (recommended!)](#the-easy-way-recommended) - [The hard way (using ruby gems)](#the-hard-way-using-ruby-gems) - [Add your own content](#add-your-own-content) - [Last important thing: parameters for each page](#last-important-thing-parameters-for-each-page) -- [Features](#features) - [Supported YAML front matter parameters](#supported-yaml-front-matter-parameters) - [Showcased users (success stories!)](#showcased-users-success-stories) - [FAQ and support](#faq-and-support) - [Credits and contributions](#credits) +## Features + +- **SIMPLE**: The primary goal of Beautiful Jekyll is to allow literally *anyone* to create a website in a few minutes. +- **Mobile-first**: Designed to look great on both large-screen and small-screen (mobile) devices. +- **Highly customizable**: Many personalization settings such as changing the background colour/image, adding a logo. +- **Two-level navigation menu**: If you have many pages and your menu is getting cluttered, separate your menu into two levels. +- **Flexible usage**: Install Beautiful Jekyll directly from GitHub or using a Ruby gem - choose the right [development method](#build-your-website-in-3-steps) for you. +- **Battle-tested**: By using Beautiful Jekyll, you'll be joining tens of thousands of users who used this theme since 2015. +- **Links to your social media**: You can easily add links to any of your social media accounts in the footer of every page. +- **Comments support**: Add comments to any page using one of the supported commenting platforms: [Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), [Utterances](https://utteranc.es/), or [Staticman](https://staticman.net). +- **Sharing blog posts on social media**: By default, all blog posts have buttons to allow people to share on Twitter/Facebook/LinkedIn. +- **Tags**: Any blog post can be tagged with keywords, and an index page showing all the tags is automatically generated. +- **Tracking analytics**: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website. +- **Photos support**: Any page can have a cover photo around its title, and any blog post can have an associated image. +- **More advanced features**: I wrote [a blog post](https://deanattali.com/2015/03/12/beautiful-jekyll-how-to-build-a-site-in-minutes/) describing some more advanced features that I used in my website that can be used in any beautiful-jekyll site. + ## Build your website in 3 steps There's a very easy way to use this theme, and there's a hard way. If you're an advanced user and want to tinker with the hard way (using ruby gems), feel free to [skip this section and jump down](#the-hard-way-using-ruby-gems). For most people (including myself), I suggest going the easy route. @@ -136,21 +152,6 @@ You can look at the top of [`aboutme.md`](https://raw.githubusercontent.com/daat If you don't include YAML then your file will not use this template. -## Features - -- **Mobile-first**: Designed to look great on both large-screen and small-screen (mobile) devices. -- **Highly customizable**: Many personalization settings such as changing the background colour/image, adding a logo. -- **Two-level navigation menu**: If you have many pages and your menu is getting cluttered, separate your menu into two levels. -- **Flexible usage**: Install Beautiful Jekyll directly from GitHub or using a Ruby gem - choose the right [development method](#build-your-website-in-3-steps) for you. -- **Battle-tested**: By using Beautiful Jekyll, you'll be joining tens of thousands of users who used this theme since 2015. -- **Links to your social media**: You can easily add links to any of your social media accounts in the footer of every page. -- **Comments support**: Add comments to any page using one of the supported commenting platforms: [Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), [Utterances](https://utteranc.es/), or [Staticman](https://staticman.net). -- **Sharing blog posts on social media**: By default, all blog posts have buttons to allow people to share on Twitter/Facebook/LinkedIn. -- **Tags**: Any blog post can be tagged with keywords, and an index page showing all the tags is automatically generated. -- **Tracking analytics**: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website. -- **Photos support**: Any page can have a cover photo around its title, and any blog post can have an associated image. -- **More advanced features**: I wrote [a blog post](https://deanattali.com/2015/03/12/beautiful-jekyll-how-to-build-a-site-in-minutes/) describing some more advanced features that I used in my website that can be used in any beautiful-jekyll site. - ## Supported YAML front matter parameters These are the main parameters you can place inside a page's YAML front matter that **Beautiful Jekyll** supports.