Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adoyle-h/jekyll-autolinks
Automatically create <a> DOMs from standard URLs for your Jekyll site.
https://github.com/adoyle-h/jekyll-autolinks
jekyll jekyll-plugin
Last synced: about 1 month ago
JSON representation
Automatically create <a> DOMs from standard URLs for your Jekyll site.
- Host: GitHub
- URL: https://github.com/adoyle-h/jekyll-autolinks
- Owner: adoyle-h
- License: bsd-3-clause
- Created: 2023-06-23T07:40:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-20T16:12:57.000Z (5 months ago)
- Last Synced: 2024-09-29T03:04:05.075Z (about 1 month ago)
- Topics: jekyll, jekyll-plugin
- Language: Ruby
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jekyll::Autolinks
Automatically create `` DOMs from standard URLs for your Jekyll site.
In any html page or post, standard URLs and emails will be autolinked.
- `https://github.com/` => `https://github.com/`.
- `[email protected]` => `[email protected]`.
Modified based on [ivantsepp/jekyll-autolink_email](https://github.com/ivantsepp/jekyll-autolink_email).
## Installation
1. Add to your `Gemfile`:
```
gem 'jekyll-autolinks'
```
2. Add to your `_config.yml`:
```yml
gems:
- jekyll-autolinks
```
## Configuration
Autolinking is done by [Rinku](https://github.com/vmg/rinku) so visit that gem for a more in-depth explanation of the configuration options:
```yml
autolinks:
link_attr: 'target="_blank"'
skip_tags: ["a", "pre", "code", "kbd", "script"]
```
- `link_attr` is a string containing the link attributes for each link that will be generated. These attributes are not sanitized and will be include as-is in each generated link, e.g.
```
link_attr: 'target="_blank" class="my-link"'
# hi.com => 'hi.com'
```
- `skip_tags` is a list of strings with the names of HTML tags that will be skipped when autolinking. If nil, this defaults to the value of the global Rinku.skip_tags, which is initially `["a", "pre", "code", "kbd", "script"]`.
## Suggestion, Bug Reporting, Contributing
**Before opening new Issue/Discussion/PR and posting any comments**, please read [Contributing Guidelines](https://gcg.adoyle.me/CONTRIBUTING).
## Copyright and License
Copyright 2023-2024 ADoyle ([email protected]). Some Rights Reserved.
The project is licensed under the **BSD 3-clause License**.
Read the [LICENSE][] file for the specific language governing permissions and limitations under the License.
Read the [NOTICE][] file distributed with this work for additional information regarding copyright ownership.
[LICENSE]: ./LICENSE
[NOTICE]: ./NOTICE