Skip to content

Commit

Permalink
Fix broken links on docs site.
Browse files Browse the repository at this point in the history
  • Loading branch information
@eli64s
eli64s committed Oct 25, 2024
1 parent acaca2a commit 8c5e41f
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 71 deletions.
12 changes: 6 additions & 6 deletions docs/docs/configuration/badges.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,12 @@ The `--badge-color` option **only** modifies the default badge set, while the `-

## References

Thank you to the following projects for providing the badges used in this project:
Thank you to the following resources for providing open-source badges and icons:

- [Shields.io](https://shields.io/)
- [Aveek-Saha/GitHub-Profile-Badges](https://github.com/Aveek-Saha/GitHub-Profile-Badges)
- [Ileriayo/Markdown-Badges](https://github.com/Ileriayo/markdown-badges)
- [tandpfun/skill-icons](https://github.com/tandpfun/skill-icons)
```
* [Shields.io](https://shields.io/)
* [Simple Icons](https://simpleicons.org/)
* [Aveek-Saha/GitHub-Profile-Badges](https://github.com/Aveek-Saha/GitHub-Profile-Badges)
* [Ileriayo/Markdown-Badges](https://github.com/Ileriayo/markdown-badges)
* [tandpfun/skill-icons](https://github.com/tandpfun/skill-icons)

---
48 changes: 24 additions & 24 deletions docs/docs/configuration/header.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,25 +53,25 @@ A header template style determines how your project's header section is structur
<ul class="feature-list">
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Centered alignment</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Logo above project name</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Traditional README layout</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Ideal for most projects</span>
</div>
</li>
Expand Down Expand Up @@ -113,25 +113,25 @@ A header template style determines how your project's header section is structur
<ul class="feature-list">
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Left-aligned layout</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Logo and title on same line</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Space-efficient design</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Perfect for smaller README files</span>
</div>
</li>
Expand Down Expand Up @@ -170,25 +170,25 @@ A header template style determines how your project's header section is structur
<ul class="feature-list">
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Left-aligned text</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Logo floated to the right</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Contemporary asymmetric design</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Great for documentation sites</span>
</div>
</li>
Expand Down Expand Up @@ -235,25 +235,25 @@ A header template style determines how your project's header section is structur
<ul class="feature-list">
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Full-width SVG banner support</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Centered alignment</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Scalable vector graphics</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Ideal for custom branding</span>
</div>
</li>
Expand Down Expand Up @@ -306,25 +306,25 @@ A header template style determines how your project's header section is structur
<ul class="feature-list">
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Text-based art logo</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Minimal and retro style</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">No image dependencies</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Good for terminal-focused tools</span>
</div>
</li>
Expand Down Expand Up @@ -383,25 +383,25 @@ A header template style determines how your project's header section is structur
<ul class="feature-list">
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Text-based art logo</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Minimal and retro style</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">No image dependencies</span>
</div>
</li>
<li>
<div class="feature-item">
<span class="feature-icon">◎</span>
<span class="feature-icon">•</span>
<span class="feature-text">Good for terminal-focused tools</span>
</div>
</li>
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/configuration/project_logo.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,28 +81,28 @@ This will generate a unique logo that you can display in your project's document
=== "[1. eli64/readme-ai](https://github.com/eli64s/readme-ai)"

<p align="center">
<img src="https://github.com/eli64s/readme-ai/blob/main/docs/assets/images/llm-content/dalle/readme-ai-bot.png?raw=true" width="200" alt="Project Logo">
<img src="https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/llm-content/dalle/readme-ai-bot.png?raw=true" width="200" alt="Project Logo">
</p>
<h1 align="center">README-AI</h1>

=== "[2. eli64/sreadme-ai](https://github.com/eli64s/readme-ai)"

<p align="center">
<img src="https://github.com/eli64s/readme-ai/blob/main/docs/assets/images/llm-content/dalle/readme-ai-feather.png?raw=true" width="200" alt="Project Logo">
<img src="https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/llm-content/dalle/readme-ai-feather.png?raw=true" width="200" alt="Project Logo">
</p>
<h1 align="center">README-AI</h1>

=== "[3. eli64/readme-ai-streamlit](https://github.com/eli64s/readme-ai-streamlit)"

<p align="center">
<img src="https://github.com/eli64s/readme-ai/blob/main/docs/assets/images/llm-content/dalle/readme-ai-streamlit.png?raw=true" width="200" alt="Project Logo">
<img src="https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/llm-content/dalle/readme-ai-streamlit.png?raw=true" width="200" alt="Project Logo">
</p>
<h1 align="center">README-AI-STREAMLIT</h1>

=== "[4. PiyushSuthar/github-readme-quotes](https://github.com/PiyushSuthar/github-readme-quotes)"

<p align="center">
<img src="https://github.com/eli64s/readme-ai/blob/main/docs/assets/images/llm-content/dalle/github-readme-quotes.png?raw=true" width="200" alt="Project Logo">
<img src="https://github.com/eli64s/readme-ai/blob/main/examples/logos/dalle.png?raw=true" width="200" alt="Project Logo">
</p>
<h1 align="center">GITHUB-README-QUOTES</h1>

Expand Down
70 changes: 36 additions & 34 deletions docs/docs/examples/gallery.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,46 +3,48 @@ title: Gallery
---

Explore various README examples from different programming languages and technologies. Each example showcases a README file from a different repository and project type.

| Technology | Example Output | Repository | Description |
|------------|---------------|------------|-------------|
| Python | [readme-python.md][0a] | [readme-ai][0b] | Core readme-ai project |
| TypeScript & React | [readme-typescript.md][1a] | [ChatGPT App][1b] | React Native ChatGPT app |
| PostgreSQL & DuckDB | [readme-postgres.md][2a] | [Buenavista][2b] | Postgres proxy server |
| Kotlin & Android | [readme-kotlin.md][3a] | [file.io Client][3b] | Android file sharing app |
| Streamlit | [readme-streamlit.md][4a] | [readme-ai-streamlit][4b] | Streamlit UI for readme-ai app |
| Rust & C | [readme-rust-c.md][5a] | [CallMon][5b] | System call monitoring tool |
| Go | [readme-go.md][6a] | [docker-gs-ping][6b] | Dockerized Go app |
| Java | [readme-java.md][7a] | [Minimal-Todo][7b] | Minimalist todo Java app |
| FastAPI & Redis | [readme-fastapi-redis.md][8a] | [async-ml-inference][8b] | Async ML inference service |
| Jupyter Notebook | [readme-mlops.md][9a] | [mlops-course][9b] | MLOps course repository |
| Apache Flink | [readme-local.md][10a] | Local Directory | Example using a local directory |
| Readme-ai | [readme-ai.md][default] | [readme-ai][readme-ai] | Readme-ai project |
| Apache Flink | [readme-pyflink.md][modern-header] | [pyflink-poc][pyflink] | Pyflink project |
| Streamlit | [readme-streamlit.md][svg-banner] | [readme-ai-streamlit][streamlit] | Streamlit web app |
| Vercel & NPM | [readme-vercel.md][dalle-logo] | [github-readme-quotes][vercel] | Vercel deployment |
| Go & Docker | [readme-docker-go.md][for-the-badge] | [docker-gs-ping][docker-golang] | Dockerized Go app |
| FastAPI & Redis | [readme-fastapi-redis.md][fastapi-redis] | [async-ml-inference][fastapi] | Async ML inference service |
| Java | [readme-java.md][compact-header] | [Minimal-Todo][java] | Minimalist todo Java app |
| PostgreSQL & DuckDB | [readme-postgres.md][classic-header] | [Buenavista][postgres] | Postgres proxy server |
| Kotlin | [readme-kotlin.md][readme-kotlin] | [android-client][kotlin] | Android client app |
| Offline Mode | [offline-mode.md][offline-mode] | [litellm][litellm] | LLM API service |

Find additional README examples in the [examples directory](https://github.com/eli64s/readme-ai/tree/main/examples).

## Share Your README

To improve readme-ai and grow the community, we'd love to see the READMEs you created. If you have a README file that you'd like to share, please share it with us [here](https://github.com/eli64s/readme-ai/discussions/categories/show-and-tell). Cheers!

<!-- README Example Links -->
[0a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-ai.md "readme-python.md"
[0b]: https://github.com/eli64s/readme-ai "readme-ai"
[1a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-typescript.md "readme-typescript.md"
[1b]: https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript "ChatGPT App"
[2a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-postgres.md "readme-postgres.md"
[2b]: https://github.com/jwills/buenavista "Buenavista"
[3a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-kotlin.md "readme-kotlin.md"
[3b]: https://github.com/rumaan/file.io-Android-Client "file.io Client"
[4a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-streamlit-v0.5.88.md "readme-streamlit.md"
[4b]: https://github.com/eli64s/readme-ai-streamlit "readme-ai-streamlit"
[5a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-rust-c.md "readme-rust-c.md"
[5b]: https://github.com/DownWithUp/CallMon "CallMon"
[6a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-docker-go.md "readme-docker-go.md"
[6b]: https://github.com/olliefr/docker-gs-ping "docker-gs-ping"
[7a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-java.md "readme-java.md"
[7b]: https://github.com/avjinder/Minimal-Todo "Minimal-Todo"
[8a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-fastapi-redis.md "readme-fastapi-redis.md"
[8b]: https://github.com/FerrariDG/async-ml-inference "async-ml-inference"
[9a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-mlops.md "readme-mlops.md"
[9b]: https://github.com/GokuMohandas/mlops-course "mlops-course"
[10a]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-local.md "readme-local.md"
---

<!-- Example READMEs -->
[default]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-ai.md "readme-python.md"
[ascii-header]: https://github.com/eli64s/readme-ai/blob/main/examples/headers/ascii.md "ascii.md"
[classic-header]: https://github.com/eli64s/readme-ai/blob/main/examples/headers/classic.md "readme-postgres.md"
[compact-header]: https://github.com/eli64s/readme-ai/blob/main/examples/headers/compact.md "readme-java.md"
[modern-header]: https://github.com/eli64s/readme-ai/blob/main/examples/headers/modern.md "readme-pyflink.md"
[svg-banner]: https://github.com/eli64s/readme-ai/blob/main/examples/banners/svg-banner.md "readme-streamlit.md"
[dalle-logo]: https://github.com/eli64s/readme-ai/blob/main/examples/logos/dalle.md "readme-vercel.md"
[readme-kotlin]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-kotlin.md "readme-kotlin.md"
[for-the-badge]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-docker-go.md "readme-docker-go.md"
[fastapi-redis]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-fastapi-redis.md "readme-fastapi-redis.md"
[offline-mode]: https://github.com/eli64s/readme-ai/blob/main/examples/offline-mode/readme-litellm.md "readme-litellm.md"

<!-- Example Repositories -->
[readme-ai]: https://github.com/eli64s/readme-ai "readme-ai"
[pyflink]: https://github.com/eli64s/pyflink-poc "pyflink-poc"
[postgres]: https://github.com/jwills/buenavista "Buenavista"
[java]: https://github.com/avjinder/Minimal-Todo "minimal-todo"
[kotlin]: https://github.com/rumaan/file.io-Android-Client "android-client"
[docker-golang]: https://github.com/olliefr/docker-gs-ping "docker-gs-ping"
[vercel]: https://github.com/PiyushSuthar/github-readme-quotes "github-readme-quotes"
[streamlit]: https://github.com/eli64s/readme-ai-streamlit "readme-ai-streamlit"
[fastapi]: https://github.com/FerrariDG/async-ml-inference "async-ml-inference"
[litellm]: https://github.com/BerriAI/litellm "offline-mode"
5 changes: 2 additions & 3 deletions docs/docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
<div class="hero-section">
<div class="hero-content">
<div class="logo-container">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/63173801d4b8115d523eb1ed8e145613545095de/docs/assets/icons/readme-ai-logo-gradient.svg"
width="450"
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-animated.svg"
alt="readme-ai">
</div>
<h2 class="tagline">
Expand All @@ -13,7 +12,7 @@
Modern documentation generator combining advanced AI with robust data processing
</p>
<div class="cta-buttons">
<a href="https://eli64s.github.io/readme-ai/quickstart/prerequisites" class="button primary">
<a href="https://eli64s.github.io/readme-ai/usage/prerequisites/" class="button primary">
Getting Started →
</a>
<a href="https://github.com/eli64s/readme-ai" class="button secondary">
Expand Down

0 comments on commit 8c5e41f

Please sign in to comment.