From cb73c8ba573b4a290aa2f00a97b7f48440b06ab9 Mon Sep 17 00:00:00 2001 From: Jacob Cain <jrcain@usgs.gov> Date: Tue, 3 Oct 2023 16:18:45 -0700 Subject: [PATCH] Navigation/directory structure --- .../custom_theme => custom_theme}/main.html | 0 docs/concepts/index.md | 1 + {landing_page/docs => docs}/css/extras.css | 0 .../docs => docs}/css/neoteroi-mkdocs.css | 0 docs/getting-started/index.md | 1 + docs/how-to-guides/index.md | 1 + {landing_page/docs => docs}/index.md | 0 landing_page/mkdocs.yml => mkdocs.yml | 14 +++++++++++++- landing_page/requirements.txt => requirements.txt | 0 9 files changed, 16 insertions(+), 1 deletion(-) rename {landing_page/custom_theme => custom_theme}/main.html (100%) create mode 100644 docs/concepts/index.md rename {landing_page/docs => docs}/css/extras.css (100%) rename {landing_page/docs => docs}/css/neoteroi-mkdocs.css (100%) create mode 100644 docs/getting-started/index.md create mode 100644 docs/how-to-guides/index.md rename {landing_page/docs => docs}/index.md (100%) rename landing_page/mkdocs.yml => mkdocs.yml (75%) rename landing_page/requirements.txt => requirements.txt (100%) diff --git a/landing_page/custom_theme/main.html b/custom_theme/main.html similarity index 100% rename from landing_page/custom_theme/main.html rename to custom_theme/main.html diff --git a/docs/concepts/index.md b/docs/concepts/index.md new file mode 100644 index 0000000..74d42e1 --- /dev/null +++ b/docs/concepts/index.md @@ -0,0 +1 @@ +# Concepts diff --git a/landing_page/docs/css/extras.css b/docs/css/extras.css similarity index 100% rename from landing_page/docs/css/extras.css rename to docs/css/extras.css diff --git a/landing_page/docs/css/neoteroi-mkdocs.css b/docs/css/neoteroi-mkdocs.css similarity index 100% rename from landing_page/docs/css/neoteroi-mkdocs.css rename to docs/css/neoteroi-mkdocs.css diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md new file mode 100644 index 0000000..bad5562 --- /dev/null +++ b/docs/getting-started/index.md @@ -0,0 +1 @@ +# Getting Started diff --git a/docs/how-to-guides/index.md b/docs/how-to-guides/index.md new file mode 100644 index 0000000..61ca6fd --- /dev/null +++ b/docs/how-to-guides/index.md @@ -0,0 +1 @@ +# How-To Guides diff --git a/landing_page/docs/index.md b/docs/index.md similarity index 100% rename from landing_page/docs/index.md rename to docs/index.md diff --git a/landing_page/mkdocs.yml b/mkdocs.yml similarity index 75% rename from landing_page/mkdocs.yml rename to mkdocs.yml index 45c50bd..ead6289 100644 --- a/landing_page/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,15 @@ theme: name: material custom_dir: custom_theme/ + features: + - navigation.expand + - navigation.path + - navigation.sections + - navigation.instant + - navigation.instant.progress + - navigation.tabs + + palette: # Palette toggle for dark mode - media: "(prefers-color-scheme: dark)" @@ -23,7 +32,10 @@ theme: nav: - - Links To Software Docs: index.md + - Home: index.md + - Getting Started: getting-started/index.md + - How-To Guides: how-to-guides/index.md + - Concepts: concepts/index.md extra_css: - css/neoteroi-mkdocs.css diff --git a/landing_page/requirements.txt b/requirements.txt similarity index 100% rename from landing_page/requirements.txt rename to requirements.txt -- GitLab