Skip to content

Commit

Permalink
updated CI & render
Browse files Browse the repository at this point in the history
  • Loading branch information
samapriya committed Oct 19, 2023
1 parent 0f5c8ab commit 471c08a
Show file tree
Hide file tree
Showing 11 changed files with 182 additions and 24 deletions.
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
github: samapriya
ko_fi: samapriya
custom:
- buymeacoffee.com/samapriya
35 changes: 26 additions & 9 deletions .github/workflows/publish_site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,33 @@ on:
- main

jobs:
build:
name: Deploy docs
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v2
- name: remove requirements file
- name: Checkout repository
uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install Python dependencies
run: |
rm -Rf requirements.txt
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
pip install \
"wheel" \
"lxml" \
"mkdocs-material" \
"cairosvg>=2.5" \
"mkdocs-git-committers-plugin-2>=1.1.1" \
"mkdocs-git-revision-date-localized-plugin>=1.0" \
"mkdocs-git-authors-plugin" \
"mkdocs-minify-plugin>=0.3" \
"mkdocs-rss-plugin>=1.2" \
"mkdocs-redirects>=1.0" \
"pillow<10"
- name: Deploy documentation
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
mkdocs gh-deploy --force
mkdocs --version
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
argofloats.openoceans.xyz
6 changes: 6 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# argofloats: Simple CLI for ArgoVis and Argofloats

[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=plastic&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/samapriya/)
[![Medium](https://img.shields.io/badge/Medium-12100E?style=flat&logo=medium&logoColor=white)](https://medium.com/@samapriyaroy)
[![Twitter URL](https://img.shields.io/twitter/follow/samapriyaroy?style=social)](https://twitter.com/intent/follow?screen_name=samapriyaroy)
[![Mastodon Follow](https://img.shields.io/mastodon/follow/109627075086849826?domain=https%3A%2F%2Fmapstodon.space%2F)](https://mapstodon.space/@samapriya)
[![Donate](https://img.shields.io/badge/Donate-Buy%20me%20a%20Coffee-teal)](https://www.buymeacoffee.com/samapriya)
[![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/samapriya)
[![Twitter URL](https://img.shields.io/twitter/follow/samapriyaroy?style=social)](https://twitter.com/intent/follow?screen_name=samapriyaroy)
[![Hits-of-Code](https://hitsofcode.com/github/samapriya/argofloats?branch=main)](https://hitsofcode.com/github/samapriya/argofloats?branch=main)
[![CI argofloats](https://github.com/samapriya/argofloats/actions/workflows/CI.yml/badge.svg)](https://github.com/samapriya/argofloats/actions/workflows/CI.yml)
Expand Down
63 changes: 48 additions & 15 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,26 @@ site_url: https://github.com/samapriya

# Repository
repo_name: argofloats
repo_url: https://github.com/samapriya/argofloats
repo_url: https://github.com/open-oceans/argofloats

# Copyright
copyright: 'Copyright &copy; 2021 - 2022 Samapriya Roy'

copyright: "Copyright &copy; 2020 - 2024 Samapriya Roy"

# Configuration
theme:
name: 'material'
name: "material"
custom_dir: overrides
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- search.highlight
- search.share
- search.suggest
- toc.follow

# 404 page
static_templates:
Expand All @@ -26,9 +37,18 @@ theme:
# Default values, taken from mkdocs_theme.yml
language: en
palette:
scheme: default
primary: cyan
accent: deep orange
- scheme: default
primary: cyan
accent: deep orange
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: red
accent: red
toggle:
icon: material/toggle-switch
name: Switch to light mode
font:
text: Google Sans
code: Regular
Expand All @@ -43,10 +63,22 @@ extra:
link: https://github.com/samapriya
- icon: fontawesome/brands/medium
link: https://medium.com/@samapriyaroy
- icon: fontawesome/brands/mastodon
link: https://mapstodon.space/@samapriya
- icon: fontawesome/brands/twitter
link: https://twitter.com/samapriyaroy
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/samapriya
extra_css:
- stylesheets/extra.css

plugins:
- search
- git-revision-date-localized:
enable_creation_date: true
type: timeago
- minify:
minify_html: true

# Extensions
markdown_extensions:
Expand All @@ -69,6 +101,9 @@ markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
Expand All @@ -88,20 +123,18 @@ markdown_extensions:
custom_checkbox: true
- pymdownx.tilde



# Page tree
nav:
- Introduction: index.md
- License: license.md
- General Installation: installation.md
- General overview:
- Overview & stats: projects/overview.md
- Overview & stats: projects/overview.md
- Metadata tools:
- Platform metadata: projects/platform.md
- Profile metadata: projects/profile.md
- Platform metadata: projects/platform.md
- Profile metadata: projects/profile.md
- Data Export:
- Global search: projects/global_search.md
- Platform Profiles Export: projects/platform_profiles.md
- Profile Export: projects/profile_export.md
- Global search: projects/global_search.md
- Platform Profiles Export: projects/platform_profiles.md
- Profile Export: projects/profile_export.md
- Changelog: changelog.md
18 changes: 18 additions & 0 deletions overrides/assets/javascripts/custom.a678ee80.min.js

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions overrides/assets/javascripts/custom.a678ee80.min.js.map

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions overrides/assets/javascripts/iconsearch_index.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions overrides/assets/stylesheets/custom.f7ec4df2.min.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions overrides/assets/stylesheets/custom.f7ec4df2.min.css.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 471c08a

Please sign in to comment.