Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add banner to README #3

Merged
merged 4 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/validate-url.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on: # yamllint disable-line rule:truthy
branches:
- main
jobs:
deploy:
validate_url:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.DS_Store
venv/
docs/*png
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# AI for Grant Writing

![logo](./banner.png)

A curated list of resources for using AI to develop more competitive grant applications.

- [AI For Grant Writing](#ai-for-grant-writing)
Expand Down
Binary file added banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
toc_depth: 3
---
# AI for Grant Writing

![logo](./banner.png)

A curated list of resources for using AI to develop more competitive grant applications.


Expand Down
3 changes: 3 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
label.md-nav__title {
display: none;
}

/* Style logo */
img[alt=logo] { max-width: 800px; }
8 changes: 8 additions & 0 deletions mkindex.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
"""

import argparse
import os
import pathlib
import re
import shutil
import sys
import urllib.request

Expand All @@ -30,6 +32,9 @@ def validate_single_url(url):
raise Exception(f"Failed to parse URL: {url}")
else:
if not r.scheme or not r.netloc:
# is it a path?
if os.path.exists(url):
return
raise Exception(f"URL appears to be mal-formatted: {url}")

# Now do a quick check to see if the page actually exists
Expand Down Expand Up @@ -119,3 +124,6 @@ def add_toc_depth_limit():
for ln in filter_gh_toc(lines):
print(ln, file=handle, end="")

# Copy banner.png
shutil.copyfile("banner.png", INDEX_MD_PATH.parent / "banner.png")