https://github.com/asfhyp3/mkdocs-asf-theme
An extension of the MkDocs Material Theme for ASF
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
2 of 4 committers (50.0%) from academic institutions -
✓Institutional organization owner
Organization asfhyp3 has institutional domain (hyp3-docs.asf.alaska.edu) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.9%) to scientific vocabulary
Repository
An extension of the MkDocs Material Theme for ASF
Basic Info
- Host: GitHub
- Owner: ASFHyP3
- License: bsd-3-clause
- Language: HTML
- Default Branch: develop
- Size: 277 KB
Statistics
- Stars: 1
- Watchers: 14
- Forks: 3
- Open Issues: 8
- Releases: 10
Metadata Files
README.md
ASF MkDocs Theme
An extension of the MkDocs Material Theme for ASF.
Quickstart
This theme is distributed on PyPI and can be installed into a Python 3.10+ environment using pip:
python -m pip install mkdocs-asf-theme
To use this theme, add the following lines to your mkdocs.yml:
yaml
theme:
name: asf-theme
To see an example of using this theme, see ASF HyP3's MkDocs repository which generates ASF HyP3's documentation.
Customization
[!WARNING] You should NOT include the
navigation.instantfeature in yourmkdocs.yml. See https://github.com/ASFHyP3/hyp3-docs/pull/371 for more information.
This theme has been developed with sensible defaults to be used out-of-the-box by ASF documentation sites. While sections below describe how to customize the ASF-specific features of this theme, we hope most users won't need them.
Because this theme is an extension of the MkDocs Material Theme, advanced customization can be done by following the MkDocs Material Theme documentation. However, please consider either: * opening an issue and requesting any customization you need to be incorporated into this theme * Opening a pull request to this theme with your customizations so they are available to all ASF documentation sites
Analytics
You can follow https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/ to enable analytics for your site.
Logos
This theme will provide both the ASF logo and a site logo.
ASF logo
You can change the ASF logo and/or logo URL with
yaml
theme:
name: asf-theme
asf_logo: images/asf-altenate-logo.png
asf_logo_url: https://asf.alaska.edu/
or remove the ASF logo with
yaml
theme:
name: asf-theme
asf_logo:
Site logo
With the Material Theme, there are two ways to change the site logo.
You can change site logo with a direct link to an image
yaml theme: name: asf-theme logo: images/my-logo.pngor by specifying an icon
yaml theme: name: asf-theme icon: logo: material/library
To remove the site logo, specify an empty icon (and no theme logo)
yaml
theme:
name: asf-theme
icon:
logo:
Copyright notice
This theme will provide a copyright notice like
© [YEAR] Alaska Satellite Facility
where [YEAR] is replaced with the current year. You can customize the text after
© [YEAR] in your mkdocs.yml with
yaml
copyright: Alaska Satellite Facility
To turn off the copyright notice entirely, remove the site level copyright
configuration and clear the theme one with
yaml
theme:
name: asf-theme
copyright:
Social links
You can add additional social links with
yaml
extra:
social:
- icon: fontawesome/brands/gitter
link: https://gitter.im/ASFHyP3/community
You can override the theme provided social links with
yaml
theme:
name: asf-theme
social:
- icon: fontawesome/brands/gitter
link: https://gitter.im/ASFHyP3/community
Development
Upgrading mkdocs-material to a new major version
When upgrading the mkdocs-material dependency to a new major version,
you should reference the upgrade guide
for any important changes.
In particular, you should update each template .html file in asf_theme/partials
to match the latest upstream version as closely as possible.
Each template file should include a comment near the top of the file
with a link to the upstream version upon which it was based.
When updating a particular template file,
you can diff it against the linked upstream version to see what changes were made.
Then you can apply those changes to the latest upstream version of the file.
For example, when updating header.html from major version 9 to 10,
you can diff our version of header.html against the 9.x.x upstream version linked near the top of the file.
Then you can download the latest 10.x.x upstream version from https://github.com/squidfunk/mkdocs-material
and apply the diff changes, adapting them as necessary for the latest version of mkdocs-material.
You may also have to update asf_theme/assets/stylesheets/asf.css, asf_theme/partials/main.html, and asftheme/mkdocstheme.yml as appropriate.
Owner
- Name: HyP3
- Login: ASFHyP3
- Kind: organization
- Location: Fairbanks, AK
- Website: https://hyp3-docs.asf.alaska.edu/
- Twitter: ASFHyP3
- Repositories: 36
- Profile: https://github.com/ASFHyP3
Alaska Satellite Facility's Hybrid Pluggable Processing Pipeline
GitHub Events
Total
- Issues event: 1
- Delete event: 16
- Issue comment event: 3
- Push event: 11
- Pull request event: 28
- Pull request review event: 14
- Create event: 15
Last Year
- Issues event: 1
- Delete event: 16
- Issue comment event: 3
- Push event: 11
- Pull request event: 28
- Pull request review event: 14
- Create event: 15
Committers
Last synced: about 3 years ago
All Time
- Total Commits: 72
- Total Committers: 4
- Avg Commits per committer: 18.0
- Development Distribution Score (DDS): 0.208
Top Committers
| Name | Commits | |
|---|---|---|
| Joseph H Kennedy | me@j****g | 57 |
| James Rine | J****2@u****m | 8 |
| Andrew Anderson | r****9@a****u | 6 |
| Andrew Johnston | a****n@a****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 18
- Total pull requests: 65
- Average time to close issues: 3 months
- Average time to close pull requests: 2 days
- Total issue authors: 6
- Total pull request authors: 8
- Average comments per issue: 1.61
- Average comments per pull request: 0.18
- Merged pull requests: 62
- Bot issues: 0
- Bot pull requests: 19
Past Year
- Issues: 1
- Pull requests: 12
- Average time to close issues: N/A
- Average time to close pull requests: 3 days
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.08
- Merged pull requests: 10
- Bot issues: 0
- Bot pull requests: 9
Top Authors
Issue Authors
- jhkennedy (7)
- jtherrmann (4)
- asjohnston-asf (4)
- artisticlight (1)
- Alex-Lewandowski (1)
- dependabot[bot] (1)
- dgpalmieri (1)
Pull Request Authors
- dependabot[bot] (36)
- jhkennedy (22)
- jtherrmann (11)
- tools-bot (6)
- Jlrine2 (4)
- asjohnston-asf (3)
- AndrewPlayer3 (3)
- artisticlight (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 185 last-month
- Total dependent packages: 0
- Total dependent repositories: 3
- Total versions: 11
- Total maintainers: 2
pypi.org: mkdocs-asf-theme
An extension of the MkDocs Material Theme for ASF
- Homepage: https://github.com/ASFHyP3/mkdocs-asf-theme
- Documentation: https://mkdocs-asf-theme.readthedocs.io/
- License: BSD-3-Clause
-
Latest release: 0.4.0
published almost 2 years ago
Rankings
Maintainers (2)
Dependencies
- actions/checkout v4 composite
- mamba-org/setup-micromamba v1 composite
- pypa/gh-action-pypi-publish v1.8.10 composite
- mkdocs *
- mkdocs-material >=9.4.2,<10