Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/urjaacharya/redgood.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUrja Acharya <urja.acharya@huskers.unl.edu>2020-05-28 04:15:58 +0300
committerUrja Acharya <urja.acharya@huskers.unl.edu>2020-05-28 04:15:58 +0300
commiteb029836576bf6fa43780d5265ed67b85d1ddb43 (patch)
tree8980b1408e9d729598aa5a2c678caa12556cce5f
parent3b48b3d81e3763f7928d8c1eeb4bc1abebe70ccf (diff)
Added section about pinned posts
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 512fc34..2e63545 100644
--- a/README.md
+++ b/README.md
@@ -19,10 +19,14 @@ If the site is not a git repo, it is necessary to first run `git init`. Run the
## Adding contents
-The contents of your site should be in `content` folder in the root directory. The folders is the `content` folder represent dfferent sections. The `archive` and `pinnedPosts` are special sections for displaying all posts and pinned posts, respectively.
+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).