bridgetown-plausible-tag 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gem_release.yml +3 -0
- data/.github/CODEOWNERS +1 -0
- data/.github/FUNDING.yml +12 -0
- data/.github/ISSUE_TEMPLATE/bug_report.md +24 -0
- data/.github/ISSUE_TEMPLATE/feature_request.md +24 -0
- data/.github/PULL_REQUEST_TEMPLATE.md +23 -0
- data/.github/workflows/changelog.yml +32 -0
- data/.github/workflows/linters.yml +34 -0
- data/.github/workflows/pr_tests.yml +31 -0
- data/.github/workflows/push_tests.yml +33 -0
- data/.gitignore +39 -0
- data/.rspec +2 -0
- data/CHANGELOG.md +13 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/CONTRIBUTING.md +24 -0
- data/Gemfile +18 -0
- data/LICENSE +21 -0
- data/README.md +87 -0
- data/Rakefile +8 -0
- data/bin/check +3 -0
- data/bin/checks/standardrb +4 -0
- data/bin/console +14 -0
- data/bin/format +3 -0
- data/bin/formatters/standardrb +4 -0
- data/bin/rspec +29 -0
- data/bin/setup +8 -0
- data/bin/standardrb +29 -0
- data/bridgetown-plausible-tag.gemspec +35 -0
- data/bridgetown.automation.rb +16 -0
- data/lib/bridgetown-plausible-tag.rb +8 -0
- data/lib/bridgetown-plausible-tag/builder.rb +69 -0
- data/lib/bridgetown-plausible-tag/version.rb +5 -0
- data/media/banner.ai +1476 -3
- data/media/banner.png +0 -0
- metadata +116 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 5a67e8ac03664678c072024d6d4886847e18634ad5ec0c3ecf7a7f047cf60485
|
|
4
|
+
data.tar.gz: f5c3902d5b3b3b4454021b36d9057a034b65fecc5cba177da982a537f2f3307a
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 3fb939000beae54e177b4ae3b6c809468aba4033c720b7e4096de5e3df3f287750d5faadbe2b6b0a6fb3533f4306155cf1cd5b70e46596926a805f02c0ba5cbd
|
|
7
|
+
data.tar.gz: 3b72aa57563faa1b079d59239f0b583c4584a6e35b13df1f31eb93c2d665d9822a50e2bf2b70692f477eeae517452bc48e3da8fc753cb5c1103ade67454e0983
|
data/.gem_release.yml
ADDED
data/.github/CODEOWNERS
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
. @andrewmcodes
|
data/.github/FUNDING.yml
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# These are supported funding model platforms
|
|
2
|
+
|
|
3
|
+
github: andrewmcodes
|
|
4
|
+
# patreon: # Replace with a single Patreon username
|
|
5
|
+
# open_collective: # Replace with a single Open Collective username
|
|
6
|
+
# ko_fi: # Replace with a single Ko-fi username
|
|
7
|
+
# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
|
8
|
+
# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
|
9
|
+
# liberapay: # Replace with a single Liberapay username
|
|
10
|
+
# issuehunt: # Replace with a single IssueHunt username
|
|
11
|
+
# otechie: # Replace with a single Otechie username
|
|
12
|
+
# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Bug report
|
|
3
|
+
about: Create a report to help us improve
|
|
4
|
+
title: ''
|
|
5
|
+
labels: ''
|
|
6
|
+
assignees: andrewmcodes
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## What did you do?
|
|
11
|
+
|
|
12
|
+
## What did you expect to happen?
|
|
13
|
+
|
|
14
|
+
## What actually happened?
|
|
15
|
+
|
|
16
|
+
## Additional context
|
|
17
|
+
|
|
18
|
+
## Environment
|
|
19
|
+
|
|
20
|
+
**Ruby Version:**
|
|
21
|
+
|
|
22
|
+
**Framework Version (Rails, whatever):**
|
|
23
|
+
|
|
24
|
+
**Dev Api Version:**
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Feature request
|
|
3
|
+
about: Suggest an idea for this project
|
|
4
|
+
title: ''
|
|
5
|
+
labels: enhancement
|
|
6
|
+
assignees: andrewmcodes
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Is your feature request related to a problem? Please describe.
|
|
11
|
+
|
|
12
|
+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
|
13
|
+
|
|
14
|
+
## Describe the solution you'd like
|
|
15
|
+
|
|
16
|
+
A clear and concise description of what you want to happen.
|
|
17
|
+
|
|
18
|
+
## Describe alternatives you've considered
|
|
19
|
+
|
|
20
|
+
A clear and concise description of any alternative solutions or features you've considered.
|
|
21
|
+
|
|
22
|
+
## Additional context
|
|
23
|
+
|
|
24
|
+
Add any other context or screenshots about the feature request here.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
First of all, thanks for contributing!
|
|
3
|
+
|
|
4
|
+
If it's a typo fix or minor documentation update feel free to skip the rest of this template!
|
|
5
|
+
-->
|
|
6
|
+
|
|
7
|
+
## What is the purpose of this pull request?
|
|
8
|
+
|
|
9
|
+
<!--
|
|
10
|
+
If it's a bug fix, then link it to the issue, for example:
|
|
11
|
+
|
|
12
|
+
Fixes #xxx
|
|
13
|
+
-->
|
|
14
|
+
|
|
15
|
+
## What changes did you make? (overview)
|
|
16
|
+
|
|
17
|
+
## Is there anything you'd like reviewers to focus on?
|
|
18
|
+
|
|
19
|
+
## Checklist
|
|
20
|
+
|
|
21
|
+
- [ ] I've added tests for this change
|
|
22
|
+
- [ ] I've added a Changelog entry
|
|
23
|
+
- [ ] I've updated a documentation
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
name: Changelog
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
jobs:
|
|
8
|
+
changelog:
|
|
9
|
+
name: Changelog Entry Action
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
timeout-minutes: 4
|
|
12
|
+
if: "!contains(github.event.head_commit.message, '[nodoc]')"
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v2
|
|
15
|
+
- uses: actions/setup-ruby@v1
|
|
16
|
+
with:
|
|
17
|
+
ruby-version: "2.7"
|
|
18
|
+
- name: Create local changes
|
|
19
|
+
run: |
|
|
20
|
+
gem install github_changelog_generator
|
|
21
|
+
github_changelog_generator -u andrewmcodes -p bridgetown-plausible-tag --token ${{ secrets.GITHUB_TOKEN }}
|
|
22
|
+
- name: Commit files
|
|
23
|
+
run: |
|
|
24
|
+
git config --local user.email "andrewmcodes@protonmail.com"
|
|
25
|
+
git config --local user.name "Andrew Mason"
|
|
26
|
+
git add CHANGELOG.md
|
|
27
|
+
git commit -m "docs: :pencil: Update changelog [ci skip]"
|
|
28
|
+
- name: Push changes
|
|
29
|
+
uses: ad-m/github-push-action@master
|
|
30
|
+
with:
|
|
31
|
+
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
32
|
+
branch: main
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
name: Linters
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
branches:
|
|
6
|
+
- "*"
|
|
7
|
+
push:
|
|
8
|
+
branches:
|
|
9
|
+
- main
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
standardrb:
|
|
13
|
+
name: StandardRB Check Action
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
if: "!contains(github.event.head_commit.message, 'ci skip')"
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v2
|
|
18
|
+
- name: Set up Ruby 2.7
|
|
19
|
+
uses: ruby/setup-ruby@v1
|
|
20
|
+
with:
|
|
21
|
+
ruby-version: 2.7.1
|
|
22
|
+
- name: Cache gems
|
|
23
|
+
uses: actions/cache@v1
|
|
24
|
+
with:
|
|
25
|
+
path: vendor/bundle
|
|
26
|
+
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
|
|
27
|
+
restore-keys: |
|
|
28
|
+
${{ runner.os }}-gems-
|
|
29
|
+
- name: Install gems
|
|
30
|
+
run: |
|
|
31
|
+
bundle config path vendor/bundle
|
|
32
|
+
bundle install --jobs 4 --retry 3
|
|
33
|
+
- name: Run StandardRB
|
|
34
|
+
run: bin/checks/standardrb
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
name: PR Tests
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
branches:
|
|
6
|
+
- "*"
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
tests:
|
|
10
|
+
name: Rspec Tests
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
if: "!contains(github.event.head_commit.message, 'ci skip')"
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v2
|
|
15
|
+
- name: Set up Ruby 2.7
|
|
16
|
+
uses: ruby/setup-ruby@v1
|
|
17
|
+
with:
|
|
18
|
+
ruby-version: 2.7.1
|
|
19
|
+
- name: Cache gems
|
|
20
|
+
uses: actions/cache@v1
|
|
21
|
+
with:
|
|
22
|
+
path: vendor/bundle
|
|
23
|
+
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
|
|
24
|
+
restore-keys: |
|
|
25
|
+
${{ runner.os }}-gems-
|
|
26
|
+
- name: Install gems
|
|
27
|
+
run: |
|
|
28
|
+
bundle config path vendor/bundle
|
|
29
|
+
bundle install --jobs 4 --retry 3
|
|
30
|
+
- name: Run Rspec
|
|
31
|
+
run: bin/rspec
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
name: Tests
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
tests:
|
|
10
|
+
name: Rspec Tests
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
if: "!contains(github.event.head_commit.message, 'ci skip')"
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v2
|
|
15
|
+
- name: Set up Ruby 2.7
|
|
16
|
+
uses: ruby/setup-ruby@v1
|
|
17
|
+
with:
|
|
18
|
+
ruby-version: 2.7.1
|
|
19
|
+
- name: Cache gems
|
|
20
|
+
uses: actions/cache@v1
|
|
21
|
+
with:
|
|
22
|
+
path: vendor/bundle
|
|
23
|
+
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
|
|
24
|
+
restore-keys: |
|
|
25
|
+
${{ runner.os }}-gems-
|
|
26
|
+
- name: Install gems
|
|
27
|
+
run: |
|
|
28
|
+
bundle config path vendor/bundle
|
|
29
|
+
bundle install --jobs 4 --retry 3
|
|
30
|
+
- name: Run Rspec
|
|
31
|
+
run: bin/rspec
|
|
32
|
+
env:
|
|
33
|
+
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
|
data/.gitignore
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/vendor
|
|
2
|
+
/.bundle/
|
|
3
|
+
/.yardoc
|
|
4
|
+
/Gemfile.lock
|
|
5
|
+
/_yardoc/
|
|
6
|
+
/coverage/
|
|
7
|
+
/doc/
|
|
8
|
+
/pkg/
|
|
9
|
+
/spec/reports/
|
|
10
|
+
/tmp/
|
|
11
|
+
*.bundle
|
|
12
|
+
*.so
|
|
13
|
+
*.o
|
|
14
|
+
*.a
|
|
15
|
+
mkmf.log
|
|
16
|
+
*.gem
|
|
17
|
+
Gemfile.lock
|
|
18
|
+
.bundle
|
|
19
|
+
.ruby-version
|
|
20
|
+
|
|
21
|
+
# Node
|
|
22
|
+
node_modules
|
|
23
|
+
.npm
|
|
24
|
+
.node_repl_history
|
|
25
|
+
|
|
26
|
+
# Yarn
|
|
27
|
+
yarn-error.log
|
|
28
|
+
yarn-debug.log*
|
|
29
|
+
.pnp/
|
|
30
|
+
.pnp.js
|
|
31
|
+
|
|
32
|
+
# Yarn Integrity file
|
|
33
|
+
.yarn-integrity
|
|
34
|
+
|
|
35
|
+
spec/dest
|
|
36
|
+
/.bridgetown-metadata/
|
|
37
|
+
/.bridgetown-cache/
|
|
38
|
+
/.bridgetown-webpack/
|
|
39
|
+
spec/fixtures/.bridgetown-cache/
|
data/.rspec
ADDED
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## [Unreleased](https://github.com/andrewmcodes/bridgetown-plausible-tag/tree/HEAD)
|
|
4
|
+
|
|
5
|
+
[Full Changelog](https://github.com/andrewmcodes/bridgetown-plausible-tag/compare/af26111e36dbfdadda41310555ebb0d01f1593b1...HEAD)
|
|
6
|
+
|
|
7
|
+
**Merged pull requests:**
|
|
8
|
+
|
|
9
|
+
- feat: :sparkles: Add automation [\#1](https://github.com/andrewmcodes/bridgetown-plausible-tag/pull/1) ([andrewmcodes](https://github.com/andrewmcodes))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
|
data/CODE_OF_CONDUCT.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
|
10
|
+
orientation.
|
|
11
|
+
|
|
12
|
+
## Our Standards
|
|
13
|
+
|
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
|
15
|
+
include:
|
|
16
|
+
|
|
17
|
+
* Using welcoming and inclusive language
|
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
|
19
|
+
* Gracefully accepting constructive criticism
|
|
20
|
+
* Focusing on what is best for the community
|
|
21
|
+
* Showing empathy towards other community members
|
|
22
|
+
|
|
23
|
+
Examples of unacceptable behavior by participants include:
|
|
24
|
+
|
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
|
26
|
+
advances
|
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
|
28
|
+
* Public or private harassment
|
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
|
30
|
+
address, without explicit permission
|
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
32
|
+
professional setting
|
|
33
|
+
|
|
34
|
+
## Our Responsibilities
|
|
35
|
+
|
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
|
38
|
+
response to any instances of unacceptable behavior.
|
|
39
|
+
|
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
|
44
|
+
threatening, offensive, or harmful.
|
|
45
|
+
|
|
46
|
+
## Scope
|
|
47
|
+
|
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
|
49
|
+
when an individual is representing the project or its community. Examples of
|
|
50
|
+
representing a project or community include using an official project e-mail
|
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
|
53
|
+
further defined and clarified by project maintainers.
|
|
54
|
+
|
|
55
|
+
## Enforcement
|
|
56
|
+
|
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
58
|
+
reported by contacting the project team at andrewmcodes@protonmail.com. All
|
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
|
63
|
+
|
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
|
66
|
+
members of the project's leadership.
|
|
67
|
+
|
|
68
|
+
## Attribution
|
|
69
|
+
|
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
|
71
|
+
available at [https://contributor-covenant.org/version/1/4][version]
|
|
72
|
+
|
|
73
|
+
[homepage]: https://contributor-covenant.org
|
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
## Code of Conduct
|
|
4
|
+
|
|
5
|
+
Everyone interacting with the bridgetown-plausible-tag project’s codebase, issue trackers, etc. is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
6
|
+
|
|
7
|
+
## Linters
|
|
8
|
+
|
|
9
|
+
This project uses [Standard](https://github.com/testdouble/standard) for Ruby code to minimize bike shedding related to source formatting.
|
|
10
|
+
|
|
11
|
+
Please run `./bin/format` prior to submitting pull requests.
|
|
12
|
+
|
|
13
|
+
## Testing
|
|
14
|
+
|
|
15
|
+
- Run `bundle exec rspec` to run the test suite
|
|
16
|
+
|
|
17
|
+
## Overview
|
|
18
|
+
|
|
19
|
+
1. Fork it (https://github.com/andrewmcodes/bridgetown-plausible-tag/fork)
|
|
20
|
+
2. Clone the fork using `git clone` to your local development machine.
|
|
21
|
+
3. Create your feature branch (`git checkout -b my-new-feature`)
|
|
22
|
+
4. Commit your changes (`git commit -am 'Add some feature'`)
|
|
23
|
+
5. Push to the branch (`git push origin my-new-feature`)
|
|
24
|
+
6. Create a new Pull Request
|
data/Gemfile
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
source "https://rubygems.org"
|
|
4
|
+
gemspec
|
|
5
|
+
|
|
6
|
+
gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
|
|
7
|
+
|
|
8
|
+
group :development, :test do
|
|
9
|
+
gem "rake", "~> 13.0"
|
|
10
|
+
gem "standard", "~> 0.4"
|
|
11
|
+
gem "solargraph", "~> 0.39"
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
group :test do
|
|
15
|
+
gem "rspec", "~> 3.0"
|
|
16
|
+
gem "coveralls", "~> 0.8.23"
|
|
17
|
+
gem "simplecov", "~> 0.16.1"
|
|
18
|
+
end
|
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020 Andrew Mason
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<img alt="Banner" width="100%" src="media/banner.png" />
|
|
3
|
+
<h1>bridgetown-plausible-tag</h1>
|
|
4
|
+
<p>
|
|
5
|
+
<a href="LICENSE" target="_blank">
|
|
6
|
+
<img alt="License: MIT" src="https://img.shields.io/github/license/andrewmcodes/bridgetown-plausible-tag" />
|
|
7
|
+
</a>
|
|
8
|
+
<a href="https://badge.fury.io/rb/bridgetown-plausible-tag"><img src="https://badge.fury.io/rb/bridgetown-plausible-tag.svg" alt="Gem Version" height="18"></a>
|
|
9
|
+
<a href="https://codeclimate.com/github/andrewmcodes/bridgetown-plausible-tag/maintainability"><img src="https://api.codeclimate.com/v1/badges/70c0b37f13e92d32b262/maintainability" /></a>
|
|
10
|
+
<a href='https://coveralls.io/github/andrewmcodes/bridgetown-plausible-tag?branch=main'><img src='https://coveralls.io/repos/github/andrewmcodes/bridgetown-plausible-tag/badge.svg?branch=main' alt='Coverage Status' /></a>
|
|
11
|
+
<img alt="Tests" src="https://github.com/andrewmcodes/bridgetown-plausible-tag/workflows/Tests/badge.svg" />
|
|
12
|
+
<img alt="Linters" src="https://github.com/andrewmcodes/bridgetown-plausible-tag/workflows/Linters/badge.svg" />
|
|
13
|
+
<img alt="Changelog" src="https://github.com/andrewmcodes/bridgetown-plausible-tag/workflows/Changelog/badge.svg" />
|
|
14
|
+
</p>
|
|
15
|
+
</div>
|
|
16
|
+
|
|
17
|
+
- [Installation](#installation)
|
|
18
|
+
- [Configuration](#configuration)
|
|
19
|
+
- [Usage](#usage)
|
|
20
|
+
- [Demo](#demo)
|
|
21
|
+
- [Contributing](#contributing)
|
|
22
|
+
- [License](#license)
|
|
23
|
+
|
|
24
|
+
## Installation
|
|
25
|
+
|
|
26
|
+
If you're running Bridgetown v0.15 or later, you can install this plugin via an automation to guide you through the configuration:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
bundle exec bridgetown apply https://github.com/andrewmcodes/bridgetown-plausible-tag
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Otherwise, you can run this command to add this plugin to your site's Gemfile:
|
|
33
|
+
|
|
34
|
+
```shell
|
|
35
|
+
bundle add bridgetown-plausible-tag -g bridgetown_plugins
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
or add the following to your `Gemfile`:
|
|
39
|
+
|
|
40
|
+
```ruby
|
|
41
|
+
group :bridgetown_plugins do
|
|
42
|
+
gem "bridgetown-plausible-tag", "~> 0.0.1"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Run `bundle install` and then modify your `bridgetown.config.yml` configuration to point to your Plausible domain.
|
|
47
|
+
|
|
48
|
+
## Configuration
|
|
49
|
+
|
|
50
|
+
```yml
|
|
51
|
+
# bridgetown.config.yml
|
|
52
|
+
|
|
53
|
+
plausible:
|
|
54
|
+
# Your Plausible domain.
|
|
55
|
+
# Note that this domain should not include www or https://
|
|
56
|
+
#
|
|
57
|
+
# Type: String
|
|
58
|
+
# Required: true
|
|
59
|
+
domain: example.com
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Usage
|
|
63
|
+
|
|
64
|
+
This plugin provides the `plausible` Liquid tag to your site.
|
|
65
|
+
|
|
66
|
+
Use the tag in the head of your document:
|
|
67
|
+
|
|
68
|
+
```liquid
|
|
69
|
+
{% plausible %}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
[Refer to the Plausible Documentation for more information.](https://docs.plausible.io/plausible-script)
|
|
73
|
+
|
|
74
|
+
## Demo
|
|
75
|
+
|
|
76
|
+
[bridgetown-plausible-starter](https://github.com/andrewmcodes/bridgetown-plausible-starter)
|
|
77
|
+
|
|
78
|
+
This starter can be used to reproduce issues as well as provide an example of the plugin's usage.
|
|
79
|
+
|
|
80
|
+
## Contributing
|
|
81
|
+
|
|
82
|
+
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/andrewmcodes/bridgetown-plausible-tag/issues). You can also take a look at the [contributing guide](https://github.com/andrewmcodes/bridgetown-plausible-tag/blob/main/CONTRIBUTING.md).
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
## License
|
|
86
|
+
|
|
87
|
+
This plugin is released under the [MIT License](LICENSE).
|