From 417c076161186f8561247a527cc6c4644c1ac0d4 Mon Sep 17 00:00:00 2001 From: Urja Acharya Date: Mon, 8 Mar 2021 18:23:48 -0800 Subject: Documentation is in the demo of the theme itself --- README.md | 39 ++------------------------------------- 1 file changed, 2 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 5aedc95..60eb96e 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,3 @@ -# `redgood` - -`redgood` is a clean minimal javascript-less [hugo](https://gohugo.io/) theme for blogs. - -## Demo - -Here is [live demo](https://redgood.netlify.app/). [![Netlify Status](https://api.netlify.com/api/v1/badges/68a861d0-19b7-4848-aae9-a14e1a8f01b9/deploy-status)](https://app.netlify.com/sites/redgood/deploys) - -## Installation - -If the site is not a git repo, it is necessary to first run `git init`. Run the following command in the site root directory to add `redgood` as a submodule: - - git submodule add https://github.com/urjaacharya/redgood.git themes/redgood - - -## Getting started - -1. Copy the contents of [`config.toml`](https://github.com/urjaacharya/redgood/blob/master/exampleSite/config.toml) in the [exampleSite](https://github.com/urjaacharya/redgood/tree/master/exampleSite) folder to a `config.toml` in the site root directory and update it as needed. -2. Copy all the contents from [`exampleSite/content`](https://github.com/urjaacharya/redgood/tree/master/exampleSite/content) to a `content` folder in the root directory. At the least, the folders `archive` and `pinnedPosts` need to be copied. -3. Run `hugo server` to begin developing. - -## Adding contents - -The contents of your site should be in `content` folder in the root directory. The folders in the `content` folder represent dfferent sections. The `archive` and `pinnedPosts` are special sections for displaying all posts and pinned posts, respectively. - -Additional content directories for more content sections can be added as required. When adding new folders, also create a new `_index.md` file inside each folder and add `title` and `weight` relevant for that section. Refer to [`_index.md`](https://github.com/urjaacharya/redgood/blob/master/exampleSite/content/post/_index.md) for an example. - -### Pinned posts - -The theme allows for pinning posts. All pinned posts will be shown in a dedicated section (`/pinnedposts/`) and the most recent one will also be displayed at the top in the home page. For pinning posts, add `pinned = true` (or `pinned: true`) in the front matter of the markdown file for the post. Here is an [`example of pinned content`](https://github.com/urjaacharya/redgood/blob/master/exampleSite/content/post/markdown-syntax.md) for more information. - -## Contributing - -For comments, questions, and bugs, please create an issue [here](https://github.com/urjaacharya/redgood/issues). - - - +# `redgood hugo theme` +- [Live Demo and Documentation](https://redgood.netlify.app/blog/redgood_documentation/). [![Netlify Status](https://api.netlify.com/api/v1/badges/68a861d0-19b7-4848-aae9-a14e1a8f01b9/deploy-status)](https://app.netlify.com/sites/redgood/deploys) -- cgit v1.2.3