Skip to content
This repository has been archived by the owner on Jun 9, 2022. It is now read-only.

Commit

Permalink
README tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Perlkonig committed Sep 1, 2016
1 parent 9388a32 commit 59d795f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Then, wherever you want a list to appear in your theme (usually in `sidebar.html

The following are parameters you can set in the `with` portion of your `include`. If they are not specified, then the system first looks in your config file and then just makes a guess.

- `tags`: This is an array of at least one tag that relates to links in your config file. This is the only "required" field in that if nothing is passed, nothing will be displayed.
- `tags`: This is an array of at least one tag that relates to links in your config file. This is the only "required" field in that if nothing is passed, and a default isn't defined in your config, nothing will be displayed.

- `combinator`: Is only used if there are at least two tags. If you pass `and`, then only links that contain *all* the provided tags will be displayed. Anything else will be interpreted as `or`.

Expand Down Expand Up @@ -98,14 +98,14 @@ links:
description: "Third link"
link: "http://example.com/3"
tags: [tag1,tag2]
sortkey: ccc
sortkey: aaa
```

- The `name` is what appears in the output.

- If provided, the `description` is added after the name.
- If provided, the `description` is displayed after the name.

- The `link` is self-explanatory. The `link` field **must be unique across your entire list**! The system won't complain or anything, but you will get undefined merging and sorting results otherwise.
- The `link` is self-explanatory. **The `link` field must be unique across your entire list!** The system won't complain or anything, but you will get undefined merging and sorting results otherwise.

- The `tags` field is how you generate individual lists. When you `include` the twig file you have to specify one or more tags. The system will pull those links out for display.

Expand Down
2 changes: 1 addition & 1 deletion blogroll.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ links:
description: "Third link"
link: "http://example.com/3"
tags: [tag1,tag2]
sortkey: ccc
sortkey: aaa

0 comments on commit 59d795f

Please sign in to comment.