From f0093ebd463a1bdc713db037f2d39cb0042be5bd Mon Sep 17 00:00:00 2001 From: d33bs Date: Mon, 13 Nov 2023 14:51:13 -0700 Subject: [PATCH 1/7] add linting config --- .pre-commit-config.yaml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..ea99edc --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,27 @@ +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +--- +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: trailing-whitespace + - id: end-of-file-fixer + - id: check-added-large-files + - id: detect-private-key + # checking spelling + - repo: https://github.com/codespell-project/codespell + rev: v2.2.6 + hooks: + - id: codespell + # checking markdown formatting + - repo: https://github.com/executablebooks/mdformat + rev: 0.7.17 + hooks: + - id: mdformat + additional_dependencies: + - mdformat-gfm + - repo: https://github.com/Lucas-C/pre-commit-hooks-nodejs + rev: v1.1.2 + hooks: + - id: htmllint From 65b5f473d39456a27c8dcb6127bc0a5c43633a44 Mon Sep 17 00:00:00 2001 From: d33bs Date: Mon, 13 Nov 2023 14:51:24 -0700 Subject: [PATCH 2/7] add html linting config --- .htmllintrc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .htmllintrc diff --git a/.htmllintrc b/.htmllintrc new file mode 100644 index 0000000..31b29c9 --- /dev/null +++ b/.htmllintrc @@ -0,0 +1,21 @@ +{ + "tag-bans": [ + "b", + "i" + ], + "attr-bans": [ + "align", + "background", + "bgcolor", + "border", + "frameborder", + "longdesc", + "marginwidth", + "marginheight", + "scrolling", + "width" + ], + "attr-quote-style": false, + "indent-width": false, + "id-class-style": false +} From c5ae82f8db48e428b72fbf117b68370c761478d0 Mon Sep 17 00:00:00 2001 From: d33bs Date: Mon, 13 Nov 2023 14:51:32 -0700 Subject: [PATCH 3/7] add nojekyll config --- docs/.nojekyll | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/.nojekyll diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 From 9e901503114b716b6fbba6107a0e07e84faa577a Mon Sep 17 00:00:00 2001 From: d33bs Date: Mon, 13 Nov 2023 14:51:40 -0700 Subject: [PATCH 4/7] update readme and license --- LICENSE | 2 +- README.md | 10 ++++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/LICENSE b/LICENSE index c8a7128..91010d0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2023, cytomining +Copyright (c) 2023, Cytomining Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/README.md b/README.md index d00ae1d..3a04cdc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,8 @@ -# cytomining.github.io -Cytomining organization GitHub Pages configuration. +# Cytomining organization GitHub Pages configuration + +This repo includes content which helps create links via GitHub Pages related to the Cytomining Organization. + +## Development + +HTML content may be placed within the `/docs` folder which is then rendered on merge to `main`. +Work here is adapted from [the documentation found in this Gist](https://gist.github.com/domenic/1f286d415559b56d725bee51a62c24a7). From 9dca6c98a3adb466e9107936ce78ca82ecefccd1 Mon Sep 17 00:00:00 2001 From: d33bs Date: Mon, 13 Nov 2023 14:52:25 -0700 Subject: [PATCH 5/7] add html redirect pages for cytomining --- docs/cytosnake/index.html | 13 +++++++++++++ docs/index.html | 13 +++++++++++++ docs/pycytominer/index.html | 13 +++++++++++++ 3 files changed, 39 insertions(+) create mode 100644 docs/cytosnake/index.html create mode 100644 docs/index.html create mode 100644 docs/pycytominer/index.html diff --git a/docs/cytosnake/index.html b/docs/cytosnake/index.html new file mode 100644 index 0000000..4e90364 --- /dev/null +++ b/docs/cytosnake/index.html @@ -0,0 +1,13 @@ + + + + + + + + Redirecting to https://cytosnake.readthedocs.io/ + + + Redirecting to https://cytosnake.readthedocs.io/ + + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..1d239e6 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,13 @@ + + + + + + + + Redirecting to https://github.com/cytomining + + + Redirecting to https://github.com/cytomining + + diff --git a/docs/pycytominer/index.html b/docs/pycytominer/index.html new file mode 100644 index 0000000..0a8e2fb --- /dev/null +++ b/docs/pycytominer/index.html @@ -0,0 +1,13 @@ + + + + + + + + Redirecting to https://pycytominer.readthedocs.io/ + + + Redirecting to https://pycytominer.readthedocs.io/ + + From f1937722125ca263765df1b1797c8f4a1028fa6e Mon Sep 17 00:00:00 2001 From: d33bs Date: Mon, 13 Nov 2023 14:54:39 -0700 Subject: [PATCH 6/7] add github actions for pre-commit checks --- .github/workflows/pre-commit-checks.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/workflows/pre-commit-checks.yaml diff --git a/.github/workflows/pre-commit-checks.yaml b/.github/workflows/pre-commit-checks.yaml new file mode 100644 index 0000000..3777582 --- /dev/null +++ b/.github/workflows/pre-commit-checks.yaml @@ -0,0 +1,16 @@ +# used for running pre-commit checks +name: pre-commit checks +on: + push: + branches: [main] + pull_request: + branches: [main] +jobs: + run_pre_commit_tests: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v4 + with: + python-version: "3.10" + - uses: pre-commit/action@v3.0.0 From e5bddf972d60aa65a23ecb71c779d8012e1ad854 Mon Sep 17 00:00:00 2001 From: Dave Bunten Date: Mon, 13 Nov 2023 15:22:39 -0700 Subject: [PATCH 7/7] Update README.md Co-authored-by: Gregory Way --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3a04cdc..781958a 100644 --- a/README.md +++ b/README.md @@ -4,5 +4,5 @@ This repo includes content which helps create links via GitHub Pages related to ## Development -HTML content may be placed within the `/docs` folder which is then rendered on merge to `main`. -Work here is adapted from [the documentation found in this Gist](https://gist.github.com/domenic/1f286d415559b56d725bee51a62c24a7). +You may place HTML content within the `/docs` folder, which is then rendered on merge to `main`. +We adapt work here from [the documentation found in this Gist](https://gist.github.com/domenic/1f286d415559b56d725bee51a62c24a7).