Skip to content

Commit abe4862

Browse files
committed
[DOC] added plugin_info for getkirby-plugins.com and updated readme
1 parent 591d9e0 commit abe4862

File tree

2 files changed

+52
-6
lines changed

2 files changed

+52
-6
lines changed

PLUGIN_INFO.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Introduction
2+
This kirbytag returns a beatiful download-link for a specific file in your site´s content. It generates a link with a customizable text and dispays the filesize.
3+
4+
That´s nothing special, but come some features for lazy people:
5+
You can choose your file, by the file categorization kirby uses (document, image, etc.) and the select by first or last. If you have a file, like a regularly updating flyer, you can keep going on with individual file names, but don´t have to specify the name in the tag eveny time you change your file! Isn´t this awesome?
6+
7+
8+
#### installation
9+
store this file in
10+
11+
site/tags/
12+
13+
#### usage
14+
Now you have a new kitbytext extension for download-links.
15+
The syntax is quite simple:
16+
17+
(download: $keyword type: $filetype ext: $extension text: $someLinkText)
18+
19+
First thing to replace is `$keyword`. You can choose from:
20+
21+
- "first": selects the first file
22+
- "last": selects the last file
23+
- or you can type some filename
24+
25+
Next we want to specify which files are affected. This is done with replacing `$filetype`. You can choose from the kirby file selectors:
26+
27+
- "document"
28+
- "code"
29+
- "images"
30+
- "videos"
31+
32+
To condense the selection further down, you can replace `$extension` and type a filename extension.
33+
34+
With the `text` attribute (replace `$someLinkText`) you can set a custom text which is displayed instead of the filename.
35+
36+
##### keep in mind:
37+
Of course the pattern above is only an example and not working by copying it. If some placeholder (the things with `$` at the beginning) is not replaced, you have to delete the keyword infront of it too.
38+
39+
##### examples:
40+
41+
(download: first type: document)
42+
(download: flyer.pdf text: our beautiful products)
43+
44+
45+
## contribution
46+
Feel free to fork this repository an make it better.
47+
Perhaps we can implement the viewport width feature in some way.

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,21 @@ by Jannik Beyerstedt from Hamburg, Germany
44

55

66
## return a beautiful download link for specific/ first/ last file
7-
This is an extension of kirbytext for the [kirby cms](getkirby.com), which adds an easy way to embed your self-hosted html5-video sources in a responsive layout. This means, you can use it responsive, or it´ll adapt to your layout anyway.
7+
This kirbytag returns a beatiful download-link for a specific file in your site´s content. It generates a link with a customizable text and dispays the filesize.
88

9-
I know that there are some other solutions out there, but I´m lazy, so this is the version for the lazy people.
10-
11-
This extension can handle mp4 (h.264), webm and HTTP-live-streaming sources as well as a poster. You can select, which versions you have.
12-
Another special feature is, that the videos are stored in a special folder to keen bug data in one place.
9+
That´s nothing special, but come some features for lazy people:
10+
You can choose your file, by the file categorization kirby uses (document, image, etc.) and the select by first or last. If you have a file, like a regularly updating flyer, you can keep going on with individual file names, but don´t have to specify the name in the tag eveny time you change your file! Isn´t this awesome?
1311

1412
#### note:
1513
This is only tested with kirby 2!
1614

1715

18-
#### how to use
16+
#### installation
1917
store this file in
2018

2119
site/tags/
2220

21+
#### usage
2322
Now you have a new kitbytext extension for download-links.
2423
The syntax is quite simple:
2524

0 commit comments

Comments
 (0)