Skip to content
Snippets Groups Projects
Commit 24a9c40e authored by Jacob Cain's avatar Jacob Cain
Browse files

copied mkdocs template from other repository

parent d4588b25
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
.gitignore 0 → 100644
+ 1
− 0
View file @ 24a9c40e
.DS_Store
\ No newline at end of file
landing_page/custom_theme/main.html 0 → 100644
+ 221
− 0
View file @ 24a9c40e
{% extends "base.html" %}
{% block scripts %}
<script async type="text/javascript" src="https://dap.digitalgov.gov/Universal-Federated-Analytics-Min.js?agency=DOI" id="_fed_an_ua_tag"></script>
<script type="text/javascript" src="https://asc-public-docs.s3.us-west-2.amazonaws.com/common/uswds/3.6.0/js/uswds-init.min.js"></script>
{{super()}}
{% endblock %}
{% block header %}
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<script type="text/javascript" src="https://asc-public-docs.s3.us-west-2.amazonaws.com/common/uswds/3.6.0/js/uswds-init.min.js"></script>
<script type="text/javascript" src="https://asc-public-docs.s3.us-west-2.amazonaws.com/common/uswds/3.6.0/js/uswds.min.js"></script>
</body>
<section class="usa-banner" aria-label="Official government website">
<div class="usa-accordion">
<header class="usa-banner__header">
<div class="usa-banner__inner">
<div class="grid-col-auto">
<img
class="usa-banner__header-flag"
src="https://asc-public-docs.s3.us-west-2.amazonaws.com/common/uswds/3.6.0/img/us_flag_small.png"
alt="U.S. flag"
/>
</div>
<div class="grid-col-fill tablet:grid-col-auto">
<p class="usa-banner__header-text">
An official website of the United States government
</p>
<p class="usa-banner__header-action" aria-hidden="true">
Here’s how you know
</p>
</div>
<button
type="button"
class="usa-accordion__button usa-banner__button"
aria-expanded="false"
aria-controls="gov-banner-default-default"
>
<span class="usa-banner__button-text">Here’s how you know</span>
</button>
</div>
</header>
<div
class="usa-banner__content usa-accordion__content"
id="gov-banner-default-default"
>
<div class="grid-row grid-gap-lg">
<div class="usa-banner__guidance tablet:grid-col-6">
<img
class="usa-banner__icon usa-media-block__img"
src="https://asc-public-docs.s3.us-west-2.amazonaws.com/common/uswds/3.6.0/img/icon-dot-gov.svg"
role="img"
alt=""
aria-hidden="true"
/>
<div class="usa-media-block__body">
<p>
<strong>Official websites use .gov</strong><br />A
<strong>.gov</strong> website belongs to an official government
organization in the United States.
</p>
</div>
</div>
<div class="usa-banner__guidance tablet:grid-col-6">
<img
class="usa-banner__icon usa-media-block__img"
src="https://asc-public-docs.s3.us-west-2.amazonaws.com/common/uswds/3.6.0/img/icon-https.svg"
role="img"
alt=""
aria-hidden="true"
/>
<div class="usa-media-block__body">
<p>
<strong>Secure .gov websites use HTTPS</strong><br />A
<strong>lock</strong> (
<span class="icon-lock"
><svg
xmlns="http://www.w3.org/2000/svg"
width="52"
height="64"
viewBox="0 0 52 64"
class="usa-banner__lock-image"
role="img"
aria-labelledby="banner-lock-title-default banner-lock-description-default"
focusable="false"
>
<title id="banner-lock-title-default">Lock</title>
<desc id="banner-lock-description-default">A locked padlock</desc>
<path
fill="#000000"
fill-rule="evenodd"
d="M26 0c10.493 0 19 8.507 19 19v9h3a4 4 0 0 1 4 4v28a4 4 0 0 1-4 4H4a4 4 0 0 1-4-4V32a4 4 0 0 1 4-4h3v-9C7 8.507 15.507 0 26 0zm0 8c-5.979 0-10.843 4.77-10.996 10.712L15 19v9h22v-9c0-6.075-4.925-11-11-11z"
/>
</svg> </span
>) or <strong>https://</strong> means you’ve safely connected to
the .gov website. Share sensitive information only on official,
secure websites.
</p>
</div>
</div>
</div>
</div>
</div>
</section>
<header id="navbar" class="header-nav" role="banner">
<div class="tmp-container">
<div class="header-search">
<a class="logo-header" href="https://www.usgs.gov/" title="Home">
<img class="img" src="https://asc-public-docs.s3.us-west-2.amazonaws.com/common/uswds/3.6.0/img/logo.png" alt="Home" />
</a>
<form action="https://www.usgs.gov/science-explorer-results" method="GET" id="search-box">
<div class="fa-wrapper"><label for="se_search" class="only">Search</label>
<input id="se_search" type="search" name="es" placeholder="Search">
<button class="fa fa-search" type="submit">
<span class="only">Search</span>
</button></div>
</form>
</div>
</div>
</header>
{{ super() }}
{% endblock %}
{% block footer %}
<footer class="footer">
<div class="tmp-container">
<div class="footer-doi">
<ul class="menu nav">
<li class="first leaf menu-links menu-level-1"><a href="https://www.doi.gov/privacy">DOI Privacy Policy</a></li>
<li class="leaf menu-links menu-level-1"><a href="https://www.usgs.gov/policies-and-notices">Legal</a></li>
<li class="leaf menu-links menu-level-1"><a href="https://www.usgs.gov/accessibility-and-us-geological-survey">Accessibility</a></li>
<li class="leaf menu-links menu-level-1"><a href="https://www.usgs.gov/sitemap">Site Map</a></li>
<li class="last leaf menu-links menu-level-1"><a href="https://answers.usgs.gov/">Contact USGS</a></li>
</ul>
</div>
<hr>
<div class="footer-doi">
<ul class="menu nav">
<li class="first leaf menu-links menu-level-1"><a href="https://www.doi.gov/">U.S. Department of the Interior</a></li>
<li class="leaf menu-links menu-level-1"><a href="https://www.doioig.gov/">DOI Inspector General</a></li>
<li class="leaf menu-links menu-level-1"><a href="https://www.whitehouse.gov/">White House</a></li>
<li class="leaf menu-links menu-level-1"><a href="https://www.whitehouse.gov/omb/management/egov/">E-gov</a></li>
<li class="leaf menu-links menu-level-1"><a href="https://www.doi.gov/pmb/eeo/no-fear-act">No Fear Act</a></li>
<li class="last leaf menu-links menu-level-1"><a href="https://www.usgs.gov/about/organization/science-support/foia">FOIA</a></li>
</ul>
</div>
<div class="footer-social-links">
<ul class="social">
<li class="follow">Follow</li>
<li class="twitter">
<a href="https://twitter.com/usgs" target="_blank">
<i class="fa fa-twitter-square"><span class="only">Twitter</span></i>
</a>
</li>
<li class="facebook">
<a href="https://facebook.com/usgeologicalsurvey" target="_blank">
<i class="fa fa-facebook-square"><span class="only">Facebook</span></i>
</a>
</li>
<li class="github">
<a href="https://github.com/usgs" target="_blank">
<i class="fa fa-github"><span class="only">GitHub</span></i>
</a>
</li>
<li class="flickr">
<a href="https://flickr.com/usgeologicalsurvey" target="_blank">
<i class="fa fa-flickr"><span class="only">Flickr</span></i>
</a>
</li>
<li class="youtube">
<a href="http://youtube.com/usgs" target="_blank">
<i class="fa fa-youtube-play"><span class="only">YouTube</span></i>
</a>
</li>
<li class="instagram">
<a href="https://instagram.com/usgs" target="_blank">
<i class="fa fa-instagram"><span class="only">Instagram</span></i>
</a>
</li>
</ul>
</div>
</div>
</footer>
{% endblock %}
{% block styles %}
<link href="https://asc-public-docs.s3.us-west-2.amazonaws.com/common/uswds/3.6.0/css/uswds.min.css" rel="stylesheet" type="text/css" media="screen" />
{{ super() }}
{% endblock %}
\ No newline at end of file
landing_page/docs/css/extras.css 0 → 100644
+ 2
− 0
View file @ 24a9c40e
:root {
}
\ No newline at end of file
landing_page/docs/css/neoteroi-mkdocs.css 0 → 100644
+ 137
− 0
View file @ 24a9c40e
.nt-cards {
&.nt-grid {
display: grid;
grid-auto-columns: 1fr;
gap: 0.5rem;
// the following 3 rules are for mobile devices, to avoid
// the grid forcing the width of the page
max-width: 100vw;
overflow-x: auto;
padding: 1px;
&.cols-1 {
grid-template-columns: repeat(1, 1fr);
}
&.cols-2 {
grid-template-columns: repeat(2, 1fr);
}
&.cols-3 {
grid-template-columns: repeat(3, 1fr);
}
&.cols-4 {
grid-template-columns: repeat(4, 1fr);
}
&.cols-5 {
grid-template-columns: repeat(5, 1fr);
}
&.cols-6 {
grid-template-columns: repeat(6, 1fr);
}
}
}
// for small devices
@media only screen and (max-width: 400px) {
// force one card per line
.nt-cards.nt-grid {
grid-template-columns: repeat(1, 1fr) !important;
}
}
.nt-card {
box-shadow: 0 2px 2px 0 rgb(0 0 0 / 14%), 0 3px 1px -2px rgb(0 0 0 / 20%), 0 1px 5px 0 rgb(0 0 0 / 12%);
&:hover {
box-shadow: 0 2px 2px 0 rgb(0 0 0 / 24%), 0 3px 1px -2px rgb(0 0 0 / 30%), 0 1px 5px 0 rgb(0 0 0 / 22%);
}
}
[data-md-color-scheme="slate"] {
.nt-card {
box-shadow: 0 2px 2px 0 rgb(4 40 33 / 14%), 0 3px 1px -2px rgba(96, 96, 96, 0.47), 0 1px 5px 0 rgba(255, 255, 255, 0.64);
&:hover {
box-shadow: 0 2px 2px 0 rgba(0, 0, 249, 0.27), 0 3px 1px -2px rgb(33 156 177 / 47%), 0 1px 5px 0 rgb(96 251 255 / 64%);
}
}
}
.nt-card>a {
color: var(--md-default-fg-color);
}
.nt-card>a>div {
cursor: pointer;
}
.nt-card {
padding: 5px;
margin-bottom: .5rem;
}
.nt-card-title {
font-size: 1rem;
font-weight: bold;
margin: 4px 0 8px 0;
line-height: 22px;
}
.nt-card-content {
padding: .4rem .8rem .8rem .8rem;
}
.nt-card-text {
font-size: 14px;
padding: 0;
margin: 0;
}
.nt-card .nt-card-image {
text-align: center;
border-radius: 2px;
background-position: center center;
background-size: cover;
background-repeat: no-repeat;
min-height: 120px;
}
.nt-card .nt-card-image.tags img {
margin-top: 12px
}
.nt-card .nt-card-image img {
height: 105px;
margin-top: 5px;
}
.nt-card .nt-card-icon {
text-align: center;
padding-top: 12px;
min-height: 120px;
}
.nt-card .nt-card-icon .icon {
font-size: 95px;
line-height: 1;
}
.nt-card a:hover,
.nt-card a:focus {
color: var(--md-accent-fg-color);
}
.nt-card h2 {
margin: 0;
}
landing_page/docs/index.md 0 → 100644
+ 36
− 0
View file @ 24a9c40e
---
hide:
- navigation
- toc
---
::cards:: cols=3 image-bg
[
{
"title": "ISIS",
"content": "Integrated Software for Imagers and Spectrometers",
"url" : https://isis.astrogeology.usgs.gov/,
"image" : "https://raw.githubusercontent.com/DOI-USGS/ISIS3/dev/rtd_docs/ISIS_Logo.svg"
},
{
"title": "USGSCSM",
"content": "USGS Community Sensor Models",
"url" : ../docs/software/usgscsm/index.html,
"image" : "https://raw.githubusercontent.com/DOI-USGS/usgscsm/main/docs/USGSCSM_Logo.svg"
},
{
"title": "ALE",
"content": "Abstraction Library for Ephemerides",
"url" : ../docs/software/ale/index.html,
"image" : "https://raw.githubusercontent.com/DOI-USGS/ale/main/docs/ALE_Logo.svg"
},
{
"title": "PLIO",
"content": "Planetary Input/Output Library",
"url" : ../docs/software/plio/index.html,
"image" : https://raw.githubusercontent.com/DOI-USGS/plio/main/docs/PLIO_Logo.svg
},
]
::/cards::
landing_page/mkdocs.yml 0 → 100644
+ 40
− 0
View file @ 24a9c40e
site_name: USGS Astrogeology Software Docs
theme:
name: material
custom_dir: custom_theme/
palette:
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
accent: light blue
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
accent: light blue
toggle:
icon: material/toggle-switch
name: Switch to dark mode
nav:
- Links To Software Docs: index.md
extra_css:
- css/neoteroi-mkdocs.css
- css/extras.css
- https://asc-public-docs.s3.us-west-2.amazonaws.com/common/uswds/3.6.0/css/common.css
- https://asc-public-docs.s3.us-west-2.amazonaws.com/common/uswds/3.6.0/css/custom.css
extra_javascript:
- https://asc-public-docs.s3.us-west-2.amazonaws.com/common/uswds/3.6.0/js/uswds-init.min.js
markdown_extensions:
- neoteroi.cards
landing_page/requirements.txt 0 → 100644
+ 3
− 0
View file @ 24a9c40e
mkdocs
mkdocs-material
neoteroi-mkdocs
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment