Add Cytomining organization GitHub Pages redirects for main organizat…

…ion link and existing projects (#1) * add linting config * add html linting config * add nojekyll config * update readme and license * add html redirect pages for cytomining * add github actions for pre-commit checks * Update README.md Co-authored-by: Gregory Way <[email protected]> --------- Co-authored-by: Gregory Way <[email protected]>
cytomining · Nov 13, 2023 · f8807f4 · f8807f4
1 parent 33380e0
commit f8807f4
Show file tree

Hide file tree

Showing 9 changed files with 112 additions and 3 deletions.
diff --git a/.github/workflows/pre-commit-checks.yaml 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/[email protected]
diff --git a/.htmllintrc 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
+}
diff --git a/.pre-commit-config.yaml 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
diff --git 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
@@ -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
+
+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).
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/cytosnake/index.html b/docs/cytosnake/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; URL=https://cytosnake.readthedocs.io/">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <link rel="canonical" href="https://cytosnake.readthedocs.io/">
+    <title>Redirecting to https://cytosnake.readthedocs.io/</title>
+</head>
+<body>
+    Redirecting to <a href="https://cytosnake.readthedocs.io/">https://cytosnake.readthedocs.io/</a>
+</body>
+</html>
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; URL=https://github.com/cytomining">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <link rel="canonical" href="https://github.com/cytomining">
+    <title>Redirecting to https://github.com/cytomining</title>
+</head>
+<body>
+    Redirecting to <a href="https://github.com/cytomining">https://github.com/cytomining</a>
+</body>
+</html>
diff --git a/docs/pycytominer/index.html b/docs/pycytominer/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; URL=https://pycytominer.readthedocs.io/">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <link rel="canonical" href="https://pycytominer.readthedocs.io/">
+    <title>Redirecting to https://pycytominer.readthedocs.io/</title>
+</head>
+<body>
+    Redirecting to <a href="https://pycytominer.readthedocs.io/">https://pycytominer.readthedocs.io/</a>
+</body>
+</html>