Skip to content

Commit

Permalink
Documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanfox5 committed Nov 27, 2024
1 parent 1984120 commit 6c8893d
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 31 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
<a href = "https://gogadget.jfox.io" alt="gogadget"><img src = "https://gogadget.jfox.io/img/header_black.svg" align="center"></a>

<div align = "center">
<a href = "https://github.com/jonathanfox5/gogadget/releases" alt = "Download"><img src = "https://img.shields.io/github/v/tag/jonathanfox5/gogadget?label=download&color=blue"></a>
<a href = "https://gogadget.jfox.io" alt = "Documentation"><img src = "https://img.shields.io/badge/view-documentation-brightgreen"></a>
<a href = "https://pypi.org/project/gogadget/" alt = "PyPI"><img src = "https://img.shields.io/pypi/v/gogadget?color=%23BA55D3"></a>
<h1 align="center">
<a href="https://gogadget.jfox.io"><img src="https://gogadget.jfox.io/img/header_black.svg" alt="gogadget" style="max-width: 90%;" /></a>
</h1>

<div align="center">
<a href="https://github.com/jonathanfox5/gogadget/releases"><img src="https://img.shields.io/github/v/tag/jonathanfox5/gogadget?label=download&color=blue" alt="Download" /></a>
<a href="https://gogadget.jfox.io"><img src="https://img.shields.io/badge/view-documentation-brightgreen" alt="Documentation" /></a>
<a href="https://pypi.org/project/gogadget/"><img src="https://img.shields.io/pypi/v/gogadget?color=%23BA55D3" alt="PyPI" /></a>
</div>

## Overview
Expand Down
19 changes: 1 addition & 18 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,7 @@ docs_dir: pages
copyright: Copyright &copy; 2024 Jonathan Fox

nav:
- Home:
- Introduction:
- gogadget: index.md
- Installation & Usage:
- Installation: getting_started/installation.md
- Using the tool: getting_started/using_the_tool.md
- Example commands: getting_started/example_commands.md
- "Example use case: priming": getting_started/example_use_case.md
- Reference:
- Supported languages: getting_started/supported_languages.md
- Getting dictionaries, word audio and exclude lists: getting_started/getting_resources.md
- Commands and Settings:
- Command reference: reference/command_reference.md
- Default settings: reference/default_settings.md
- Developer:
- Building: developer/building.md
- Contributing: developer/contributing.md
- Report a bug or request a feature (Github): https://github.com/jonathanfox5/gogadget/issues
- Home: index.md
- Getting Started:
- Overview:
- Useful links: getting_started/getting_started.md
Expand Down
Binary file modified docs/pages/img/affinity_designer_files/logo.afdesign
Binary file not shown.
1 change: 1 addition & 0 deletions docs/pages/img/affinity_designer_files/logo_font_link.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
https://fonts.google.com/specimen/Audiowide
17 changes: 10 additions & 7 deletions docs/pages/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
---
cards_layout_options.title: Language learning tool kit
cards_layout_options.description: Download media, generate subtitles, create Anki decks and more!
hide:
- navigation
- toc
---

<a href = "https://gogadget.jfox.io"><img src = "img/header.svg" align="center"></a>
<h1 align="center">
<a href="https://gogadget.jfox.io"><img src="img/header.svg" alt="gogadget" style="max-width: 90%;" /></a>
</h1>

#

<div align = "center">
<a href = "https://github.com/jonathanfox5/gogadget/releases" alt = "Download"><img src = "https://img.shields.io/github/v/tag/jonathanfox5/gogadget?label=download&color=blue"></a>
<a href = "https://gogadget.jfox.io" alt = "Documentation"><img src = "https://img.shields.io/badge/view-documentation-brightgreen"></a>
<a href = "https://pypi.org/project/gogadget/" alt = "PyPI"><img src = "https://img.shields.io/pypi/v/gogadget?color=%23BA55D3"></a>
<div>
<a href="https://github.com/jonathanfox5/gogadget/releases"><img src="https://img.shields.io/github/v/tag/jonathanfox5/gogadget?label=download&color=blue" alt="Download" /></a>
<a href="https://gogadget.jfox.io"><img src="https://img.shields.io/badge/view-documentation-brightgreen" alt="Documentation" /></a>
<a href="https://pypi.org/project/gogadget/"><img src="https://img.shields.io/pypi/v/gogadget?color=%23BA55D3" alt="PyPI" /></a>
</div>

`gogadget` is a toolkit for producing immersion and priming materials for language learning.
Expand Down

0 comments on commit 6c8893d

Please sign in to comment.