Skip to content

Commit

Permalink
Merge pull request #416 from techfg/add-im-website
Browse files Browse the repository at this point in the history
Add GH starter website, ESM support & misc improvements
  • Loading branch information
techfg authored Apr 6, 2024
2 parents cac142e + ece26c8 commit 25a8c14
Show file tree
Hide file tree
Showing 67 changed files with 33,016 additions and 2,861 deletions.
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ node_modules/
package-lock.json
!.*.json
!.*.jsonc
/docs/
**/*.d.ts
8 changes: 4 additions & 4 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@
"prettier",
"plugin:yml/standard",
"plugin:yml/prettier",
"plugin:markdown/recommended-legacy",
"plugin:jsonc/recommended-with-jsonc",
"plugin:jsonc/prettier"
"plugin:mdx/recommended",
"plugin:jsonc/recommended-with-jsonc"
],
"plugins": ["html"],
"reportUnusedDisableDirectives": true,
Expand All @@ -29,7 +28,8 @@
},
"settings": {
"html/indent": "+2",
"html/report-bad-indent": "error"
"html/report-bad-indent": "error",
"mdx/code-blocks": true
},
"overrides": [
{
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ body:
## Before Submitting an Issue
1. Have you read ImageMapster's [Code of Conduct](https://github.com/jamietre/ImageMapster/blob/main/CODE_OF_CONDUCT.md)? By filing an Issue, you are expected to comply with it, including treating everyone with respect.
1. Have you read ImageMapster's [Contributing Guidelines](https://github.com/jamietre/ImageMapster/blob/main/CONTRIBUTING.md)? If not, please review them before filing an issue.
1. Have you searched [existing issues](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+) to see if your issue has already been reported?
1. Do you want to ask a question? Are you looking for support? **Please do not use the issue tracker for personal support requests.** For questions, how to's, etc, please see the [Support Page](https://github.com/jamietre/ImageMapster/blob/main/SUPPORT.md) for options.
2. Have you read ImageMapster's [Contributing Guidelines](https://github.com/jamietre/ImageMapster/blob/main/CONTRIBUTING.md)? If not, please review them before filing an issue.
3. Have you searched [existing issues](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+) to see if your issue has already been reported?
4. Do you want to ask a question? Are you looking for support? **Please do not use the issue tracker for personal support requests.** For questions, how to's, etc, please see the [Support Page](https://github.com/jamietre/ImageMapster/blob/main/SUPPORT.md) for options.
- type: textarea
id: description
Expand All @@ -26,7 +26,7 @@ body:
id: reproduction
attributes:
label: Reproduction
description: Please provide a link to a location (e.g., repo, [jsFiddle](https://www.jsfiddle.net), etc.) that reproduces the problem you ran into using the latest version of ImageMapster. Please see the [contributing docs](https://github.com/jamietre/ImageMapster/blob/main/CONTRIBUTING.md) for suggestions on creating a reproduction. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) **is required** ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g., just a generic error message) and has no reproduction, it will receive a "needs author feedback" label and the issue closed until there is enough information provided.
description: Please provide a link to a location (e.g., repo, [JSFiddle](https://www.jsfiddle.net), etc.) that reproduces the problem you ran into using the latest version of ImageMapster. Please see the [contributing docs](https://github.com/jamietre/ImageMapster/blob/main/CONTRIBUTING.md) for suggestions on creating a reproduction. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) **is required** ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g., just a generic error message) and has no reproduction, it will receive a "needs author feedback" label and the issue closed until there is enough information provided.
placeholder: Reproduction URL
validations:
required: true
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ body:
## Before Submitting an Issue
1. Have you read ImageMapster's [Code of Conduct](https://github.com/jamietre/ImageMapster/blob/main/CODE_OF_CONDUCT.md)? By filing an Issue, you are expected to comply with it, including treating everyone with respect.
1. Have you read ImageMapster's [Contributing Guidelines](https://github.com/jamietre/ImageMapster/blob/main/CONTRIBUTING.md)? If not, please review them before filing an issue.
1. Have you searched [existing issues](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+) to see if your issue has already been reported?
1. Do you want to ask a question? Are you looking for support? **Please do not use the issue tracker for personal support requests.** For questions, how to's, etc, please see the [Support Page](https://github.com/jamietre/ImageMapster/blob/main/SUPPORT.md) for options.
2. Have you read ImageMapster's [Contributing Guidelines](https://github.com/jamietre/ImageMapster/blob/main/CONTRIBUTING.md)? If not, please review them before filing an issue.
3. Have you searched [existing issues](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+) to see if your issue has already been reported?
4. Do you want to ask a question? Are you looking for support? **Please do not use the issue tracker for personal support requests.** For questions, how to's, etc, please see the [Support Page](https://github.com/jamietre/ImageMapster/blob/main/SUPPORT.md) for options.
- type: textarea
id: description
Expand Down
6 changes: 4 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# IMPORTANT: Please do not create a Pull Request without creating an issue first
# IMPORTANT

Please do not create a Pull Request without creating an issue first.

## Before Submitting a Pull Request

Expand All @@ -18,7 +20,7 @@

## Description (required)

**_Please provide enough information so that others can review your pull request._**
_**Please provide enough information so that others can review your pull request.**_
Explain the **details** for making this change. What existing problem does the pull request solve and/or what capability does it add?
Example: When "Adding a function to do X", explain why it is necessary to have a way to do X.

Expand Down
49 changes: 49 additions & 0 deletions .github/workflows/gh-pages-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Deploy to GitHub Pages

on:
# Trigger the workflow every time you push to the `main` branch
# Using a different branch name? Replace `main` with your branch’s name
push:
branches: [main, add-im-website]
# Allows you to run this workflow manually from the Actions tab on GitHub.
workflow_dispatch:

# Allow this job to clone the repo and create a page deployment
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

env:
SITE_URL: https://${{ github.repository_owner }}.github.io
BASE_PATH: ${{ github.event.repository.name }}

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout your repository using git
uses: actions/checkout@v4
- name: Install, build, and upload your site output
uses: withastro/action@v2
with:
path: site
# node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 18. (optional)
# package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,5 @@ build/
.vscode/*
!.vscode/extensions.json
!.vscode/settings.json
docs/
/docs/

14 changes: 0 additions & 14 deletions .markdownlint-cli2.jsonc

This file was deleted.

1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ package-lock.json
!.*.json
!.*.jsonc
*.hbs
/docs/
3 changes: 2 additions & 1 deletion .prettierrc.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"singleQuote": true,
"trailingComma": "none"
"trailingComma": "none",
"plugins": ["prettier-plugin-astro"]
}
7 changes: 7 additions & 0 deletions .remarkignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# NOTE - This file is only used when running remark-cli, it is not used by eslint.
tests/redist/
examples/redist/
build/
dist/
node_modules/
/docs/
29 changes: 29 additions & 0 deletions .remarkrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
module.exports = {
settings: {
bullet: '-',
emphasis: '_',
listItemIndent: 'one',
quote: "'",
rule: '-',
strong: '*',
tightDefinitions: true
},
plugins: [
'remark-preset-lint-consistent',
'remark-preset-lint-markdown-style-guide',
'remark-preset-lint-recommended',
'remark-preset-prettier',
['remark-lint-list-item-indent', 'space'],
['remark-lint-maximum-line-length', false],
['remark-lint-list-item-spacing', { checkBlanks: true }],
['remark-lint-no-file-name-irregular-characters', false],
['remark-lint-ordered-list-marker-value', 'ordered'],
['remark-lint-emphasis-marker', '_'],
['remark-lint-unordered-list-marker-style', '-'],
['remark-lint-link-title-style', "'"],
['remark-lint-rule-style', '---'],
['remark-lint-strong-marker', '*'],
'remark-frontmatter',
'remark-gfm'
]
};
2 changes: 1 addition & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"recommendations": [
"dbaeumer.vscode-eslint",
"DavidAnson.vscode-markdownlint",
"unifiedjs.vscode-mdx",
"esbenp.prettier-vscode"
]
}
16 changes: 13 additions & 3 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.fixAll.markdownlint": "explicit"
"source.fixAll.eslint": "explicit"
},
"eslint.validate": ["javascript", "html", "markdown", "yaml", "json", "jsonc"]
"eslint.validate": [
"javascript",
"html",
"markdown",
"mdx",
"yaml",
"json",
"jsonc",
"typescript",
"astro"
],
"prettier.documentSelectors": ["**/*.astro"]
}
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

## Version 1.6.0 - 2024.03.12

- [Issue 394](https://github.com/jamietre/ImageMapster/issues/394) [TouchScreen only] Weird highlight glitch when touch on the other area beside the map.
- [Issue 394](https://github.com/jamietre/ImageMapster/issues/394) \[TouchScreen only] Weird highlight glitch when touch on the other area beside the map.

## Version 1.5.4 - 2021.02.20

Expand Down Expand Up @@ -190,7 +190,7 @@ Bug fixes:

Features:

- [Issue #52](https://github.com/jamietre/ImageMapster/issues/52) Add "clickNavigate" feature to allow basic imagemap functionality
- [Issue #52](https://github.com/jamietre/ImageMapster/issues/52) Add "clickNavigate" feature to allow basic image map functionality
- Add "highlight" option to programatically set/unset the highlight effect (as if a user just moused over an area vs. clicked)
- Detect touchscreen devices and disable "mouseover"
- [Issue #11](https://github.com/jamietre/ImageMapster/issues/11) Detect excanvas automatically and force into IE mode if present
Expand Down
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ members of the project's leadership.
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>.

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
<https://www.contributor-covenant.org/faq>.

[homepage]: https://www.contributor-covenant.org
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ A bug is a _demonstrable problem_ that is caused by the code in the repository.
Guidelines for bug reports:

1. **Lint your code** - Use [eslint](http://eslint.org/) to ensure your problem isn't caused by a simple error in your own code.
1. **Use the GitHub issue search** - Check if the issue has already been [reported](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+).
1. **Check if the issue has been fixed** - Try to reproduce it using the latest `main` or development branch in the repository.
1. **Isolate the problem** - Create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a [live example](https://jsfiddle.net) using the latest version of ImageMapster and preferrably, the latest version of jQuery/zepto.
2. **Use the GitHub issue search** - Check if the issue has already been [reported](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+).
3. **Check if the issue has been fixed** - Try to reproduce it using the latest `main` or development branch in the repository.
4. **Isolate the problem** - Create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a [live example](https://jsfiddle.net) using the latest version of ImageMapster and preferrably, the latest version of jQuery/zepto.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Expand Down
Loading

0 comments on commit 25a8c14

Please sign in to comment.