Skip to content

Commit 08754de

Browse files
Initial port. Tests not working
1 parent 25f2532 commit 08754de

File tree

8 files changed

+873
-219
lines changed

8 files changed

+873
-219
lines changed

LICENSE.txt

Lines changed: 339 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
Gist Filter
2+
========
3+
<!--
4+
The first paragraph of this file should be kept short as it will be used as the
5+
project summary on BackdropCMS.org. Aim for about 240 characters (three lines at
6+
80 characters each).
7+
8+
All lines in this file should be no more than 80 characters long for legibility,
9+
unless including a URL or example that requires the line to not wrap.
10+
|<- - - - - - - This line is exactly 80 characters for reference - - - - - - ->|
11+
12+
Detail in READMEs should be limited to the minimum required for installation and
13+
getting started. More detailed documentation should be moved to a GitHub wiki
14+
page; for example: https://github.com/backdrop-contrib/setup/wiki/Documentation.
15+
-->
16+
17+
Gist Filter allows gists from Github to be embedded anywhere in the text using
18+
a token format to embed as either a link, a 'code' block or embedded using one
19+
of a range of themes.
20+
21+
22+
Installation
23+
------------
24+
<!--
25+
List the steps needed to install and configure the module. Add/remove steps as
26+
necessary.
27+
-->
28+
29+
- Install this module using the official Backdrop CMS instructions at
30+
https://docs.backdropcms.org/documentation/extend-with-modules.
31+
- Enable the Gist Filter in each text format where you want to use it.
32+
33+
Usage
34+
-------------
35+
<!--
36+
Link to the repository's wiki if more documentation can be found there. Remove
37+
this section if not needed (and consider disabling the wiki in the repo settings
38+
if not used).
39+
-->
40+
41+
1. From the text format configuration page, you can configure the default
42+
display method for each text format.
43+
2. Within text using a filtered format where the filter is enabled, use the
44+
following patterns:
45+
- `[gist:123abc456def7890]` - use the default display method.
46+
- `[gistcode:123abc456def7890]` - embed the gist within `<code>` blocks.
47+
- `[gistlink:123abc456def7890]` - embed the gist as a link.
48+
- `[gistembed:123abc456def7890]` - embed the gist using a script.
49+
The gist ID is the string after the gist owner. For the examples above the gist
50+
URL would be `https://gist.github.com/yorkshire-pudding/123abc456def7890`.
51+
3. To add a specific file use `[gist:123abc456def7890:myfile.sh]` or the
52+
equivalent with a `gistcode`, `gistlink` or `gistembed` prefix.
53+
4. Go to `/admin/config/content/gist-filter` where you can select a theme for
54+
the embed display (you will need to clear the page cache to apply a change
55+
here), and also add a GitHub Personal Access token to give your site a higher
56+
limit for retrieving gists.
57+
58+
Issues
59+
------
60+
<!--
61+
Link to the repo's issue queue.
62+
-->
63+
64+
Bugs and Feature Requests should be reported in the Issue Queue:
65+
https://github.com/backdrop-contrib/gist_filter/issues.
66+
67+
68+
Current Maintainers
69+
-------------------
70+
<!--
71+
List the current maintainer(s) of the module, and note if this module needs
72+
new/additional maintainers.
73+
-->
74+
75+
- [Martin Price](https://github.com/yorkshire-pudding) - [System Horizons](https://www.systemhorizons.co.uk)
76+
- Collaboration and co-maintainers welcome!
77+
78+
Credits
79+
-------
80+
<!--
81+
Give credit where credit's due.
82+
If this is a Drupal port, state who ported it, and who wrote the original Drupal
83+
module. If this module is based on another project, or uses third-party
84+
libraries, list them here. You can also mention any organisations/companies who
85+
sponsored the module's development.
86+
-->
87+
88+
- Ported to Backdrop CMS by - [Martin Price](https://github.com/yorkshire-pudding) - [System Horizons](https://www.systemhorizons.co.uk).
89+
- Port sponsored by [System Horizons](https://www.systemhorizons.co.uk).
90+
- Originally written for Drupal by [Jake Bell](https://www.drupal.org/u/theunraveler)
91+
- Incorporating several patches by various authors from the Drupal issue queue.
92+
- Gist Embed themes by [Will Boyd](https://github.com/lonekorean)
93+
94+
License
95+
-------
96+
<!--
97+
Mention what license this module is released under, and where people can find
98+
it.
99+
-->
100+
101+
This project is GPL v2 software.
102+
See the LICENSE.txt file in this directory for complete text.

config/gist_filter.settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"_config_name": "gist_filter.settings",
3+
"github_token": "",
4+
"gist_embed_theme": "default"
5+
}

gist_filter.info

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
name = Gist Input Filter
2-
description = "Provides the ability to embed gists from Github."
2+
description = Adds a filter to embed Gists from GitHub anywhere in your text.
3+
backdrop = 1.x
4+
type = module
35

4-
; Core version (required)
5-
core = 7.x
6-
7-
; Package name (see http://drupal.org/node/101009 for a list of names)
86
package = Input filters
7+
tags[] = Filters
8+
tags[] = Content
99

10-
; Additional files
11-
files[] = gist_filter.test
10+
files[] = gist_filter.test

0 commit comments

Comments
 (0)