Skip to content

Commit f8807f4

Browse files
d33bsgwaybio
andauthored
Add Cytomining organization GitHub Pages redirects for main organization 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 <gregory.way@gmail.com> --------- Co-authored-by: Gregory Way <gregory.way@gmail.com>
1 parent 33380e0 commit f8807f4

9 files changed

Lines changed: 112 additions & 3 deletions

File tree

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# used for running pre-commit checks
2+
name: pre-commit checks
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
jobs:
9+
run_pre_commit_tests:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-python@v4
14+
with:
15+
python-version: "3.10"
16+
- uses: pre-commit/action@v3.0.0

.htmllintrc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"tag-bans": [
3+
"b",
4+
"i"
5+
],
6+
"attr-bans": [
7+
"align",
8+
"background",
9+
"bgcolor",
10+
"border",
11+
"frameborder",
12+
"longdesc",
13+
"marginwidth",
14+
"marginheight",
15+
"scrolling",
16+
"width"
17+
],
18+
"attr-quote-style": false,
19+
"indent-width": false,
20+
"id-class-style": false
21+
}

.pre-commit-config.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# See https://pre-commit.com for more information
2+
# See https://pre-commit.com/hooks.html for more hooks
3+
---
4+
repos:
5+
- repo: https://github.com/pre-commit/pre-commit-hooks
6+
rev: v4.5.0
7+
hooks:
8+
- id: trailing-whitespace
9+
- id: end-of-file-fixer
10+
- id: check-added-large-files
11+
- id: detect-private-key
12+
# checking spelling
13+
- repo: https://github.com/codespell-project/codespell
14+
rev: v2.2.6
15+
hooks:
16+
- id: codespell
17+
# checking markdown formatting
18+
- repo: https://github.com/executablebooks/mdformat
19+
rev: 0.7.17
20+
hooks:
21+
- id: mdformat
22+
additional_dependencies:
23+
- mdformat-gfm
24+
- repo: https://github.com/Lucas-C/pre-commit-hooks-nodejs
25+
rev: v1.1.2
26+
hooks:
27+
- id: htmllint

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 3-Clause License
22

3-
Copyright (c) 2023, cytomining
3+
Copyright (c) 2023, Cytomining
44

55
Redistribution and use in source and binary forms, with or without
66
modification, are permitted provided that the following conditions are met:

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1-
# cytomining.github.io
2-
Cytomining organization GitHub Pages configuration.
1+
# Cytomining organization GitHub Pages configuration
2+
3+
This repo includes content which helps create links via GitHub Pages related to the Cytomining Organization.
4+
5+
## Development
6+
7+
You may place HTML content within the `/docs` folder, which is then rendered on merge to `main`.
8+
We adapt work here from [the documentation found in this Gist](https://gist.github.com/domenic/1f286d415559b56d725bee51a62c24a7).

docs/.nojekyll

Whitespace-only changes.

docs/cytosnake/index.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta http-equiv="refresh" content="0; URL=https://cytosnake.readthedocs.io/">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<link rel="canonical" href="https://cytosnake.readthedocs.io/">
8+
<title>Redirecting to https://cytosnake.readthedocs.io/</title>
9+
</head>
10+
<body>
11+
Redirecting to <a href="https://cytosnake.readthedocs.io/">https://cytosnake.readthedocs.io/</a>
12+
</body>
13+
</html>

docs/index.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta http-equiv="refresh" content="0; URL=https://github.com/cytomining">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<link rel="canonical" href="https://github.com/cytomining">
8+
<title>Redirecting to https://github.com/cytomining</title>
9+
</head>
10+
<body>
11+
Redirecting to <a href="https://github.com/cytomining">https://github.com/cytomining</a>
12+
</body>
13+
</html>

docs/pycytominer/index.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta http-equiv="refresh" content="0; URL=https://pycytominer.readthedocs.io/">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<link rel="canonical" href="https://pycytominer.readthedocs.io/">
8+
<title>Redirecting to https://pycytominer.readthedocs.io/</title>
9+
</head>
10+
<body>
11+
Redirecting to <a href="https://pycytominer.readthedocs.io/">https://pycytominer.readthedocs.io/</a>
12+
</body>
13+
</html>

0 commit comments

Comments
 (0)