28
28
29
29
</div >
30
30
31
- <img src =" docs/docs/assets/svg/line-gradient.svg " alt =" line break " width =" 100% " height =" 3px " >
31
+ <img src =" https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/ docs/docs/assets/svg/line-gradient.svg" alt =" line break " width =" 100% " height =" 3px " >
32
32
33
33
## Quick Links
34
34
43
43
> [ !IMPORTANT]
44
44
> Explore the [ Official Documentation] [ docs ] for a complete list of features, customization options, and examples.
45
45
46
- <img src =" docs/docs/assets/svg/line-gradient.svg " alt =" line break " width =" 100% " height =" 3px " >
46
+ <img src =" https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/ docs/docs/assets/svg/line-gradient.svg" alt =" line break " width =" 100% " height =" 3px " >
47
47
48
48
## Introduction
49
49
@@ -72,7 +72,7 @@ This project aims to streamline the process of creating and maintaining document
72
72
[readmeai-streamlit-demo][streamlit-demo]
73
73
-->
74
74
75
- <img src =" docs/docs/assets/svg/line-gradient.svg " alt =" line break " width =" 100% " height =" 3px " >
75
+ <img src =" https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/ docs/docs/assets/svg/line-gradient.svg" alt =" line break " width =" 100% " height =" 3px " >
76
76
77
77
## Features
78
78
@@ -86,7 +86,7 @@ Let's begin by exploring various customization options and styles supported by R
86
86
<!-- HEADER STYLES: CLASSIC -->
87
87
<tr>
88
88
<td align="left">
89
- <img src="https://raw.githubusercontent. com/eli64s/readme-ai/main/docs/docs/assets/img/headers/custom-dragon.png"
89
+ <img src="https://github. com/eli64s/readme-ai/blob/ main/docs/docs/assets/img/documentation/ headers/variations/ custom-dragon.png?raw=true "
90
90
alt="Classic Header"
91
91
width="800"
92
92
style="border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;">
@@ -104,8 +104,8 @@ Let's begin by exploring various customization options and styles supported by R
104
104
<!-- HEADER STYLES: MODERN -->
105
105
<tr>
106
106
<td align="left">
107
- <img src="https://raw.githubusercontent. com/eli64s/readme-ai/main/examples/toc/roman-numeral .png"
108
- alt="docker-go-readme-example "
107
+ <img src="https://github. com/eli64s/readme-ai/blob/ main/docs/docs/assets/img/documentation/headers/variations/modern-for-the-badge .png?raw=true "
108
+ alt="Modern Header "
109
109
width="800"
110
110
style="border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;">
111
111
<p align="left"><b>CLI Command:</b></p>
@@ -122,7 +122,7 @@ Let's begin by exploring various customization options and styles supported by R
122
122
<!-- HEADER STYLES: COMPACT -->
123
123
<tr>
124
124
<td align="left">
125
- <img src="./ docs/docs/examples/styling/headers/compact.png"
125
+ <img src="https://github.com/eli64s/readme-ai/blob/main/ docs/docs/examples/styling/headers/compact.png?raw=true "
126
126
alt="Compact Header"
127
127
width="800"
128
128
style="border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;">
@@ -146,7 +146,7 @@ Let's begin by exploring various customization options and styles supported by R
146
146
<table >
147
147
<tr>
148
148
<td align="left">
149
- <img src="./ docs/docs/examples/styling/headers/console.png"
149
+ <img src="https://github.com/eli64s/readme-ai/blob/main/ docs/docs/examples/styling/headers/console.png?raw=true "
150
150
alt="Console Header"
151
151
width="800"
152
152
style="border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;">
@@ -165,7 +165,7 @@ Let's begin by exploring various customization options and styles supported by R
165
165
<!-- HEADER STYLES: SVG BANNER -->
166
166
<tr>
167
167
<td align="left">
168
- <img src="./ docs/docs/examples/styling/headers/svg-banner.png"
168
+ <img src="https://github.com/eli64s/readme-ai/blob/main/ docs/docs/examples/styling/headers/svg-banner.png?raw=true "
169
169
alt="SVG Banner"
170
170
width="800"
171
171
style="border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;">
@@ -186,7 +186,7 @@ Let's begin by exploring various customization options and styles supported by R
186
186
<table >
187
187
<tr>
188
188
<td align="left" style="padding: 20px;">
189
- <img src="docs/docs/assets/img/project-overview/introduction.png"
189
+ <img src="https://github.com/eli64s/readme-ai/blob/main/ docs/docs/assets/img/project-overview/introduction.png?raw=true "
190
190
alt="Project Overview"
191
191
width="800"
192
192
style="border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;">
@@ -206,7 +206,7 @@ Let's begin by exploring various customization options and styles supported by R
206
206
<!-- -->
207
207
<tr>
208
208
<td align="left" style="padding: 20px;">
209
- <img src="https://raw.githubusercontent. com/eli64s/readme-ai/refs/heads/ main/docs/docs/assets/img/headers/cloud.png"
209
+ <img src="https://github. com/eli64s/readme-ai/blob/ main/docs/docs/assets/img/documentation/ headers/variations/ cloud.png?raw=true "
210
210
alt="Custom Logo"
211
211
width="800"
212
212
style="border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;">
@@ -312,7 +312,7 @@ Let's begin by exploring various customization options and styles supported by R
312
312
313
313
</details >
314
314
315
- <img src =" docs/docs/assets/svg/line-gradient.svg " alt =" line break " width =" 100% " height =" 3px " >
315
+ <img src =" https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/ docs/docs/assets/svg/line-gradient.svg" alt =" line break " width =" 100% " height =" 3px " >
316
316
317
317
## Getting Started
318
318
@@ -648,7 +648,7 @@ If you installed the project from source with the bash script, run the following
648
648
649
649
< /details>
650
650
651
- < img src=" docs/docs/assets/svg/line-gradient.svg" alt=" line break" width=" 100%" height=" 3px" >
651
+ < img src=" https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/ docs/docs/assets/svg/line-gradient.svg" alt=" line break" width=" 100%" height=" 3px" >
652
652
653
653
# ## Testing
654
654
@@ -677,7 +677,7 @@ Using nox, test the app against Python versions `3.9`, `3.10`, `3.11`, and `3.12
677
677
> [! TIP]
678
678
> < sub> Nox is an automation tool for testing applications in multiple environments. This helps ensure your project is compatible with across Python versions and environments.< /sub>
679
679
680
- < img src=" docs/docs/assets/svg/line-gradient.svg" alt=" line break" width=" 100%" height=" 3px" >
680
+ < img src=" https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/ docs/docs/assets/svg/line-gradient.svg" alt=" line break" width=" 100%" height=" 3px" >
681
681
682
682
# # Configuration
683
683
@@ -712,7 +712,7 @@ Visit the [Official Documentation][docs] for a complete guide on configuring and
712
712
713
713
< /sub>
714
714
715
- < img src=" docs/docs/assets/svg/line-gradient.svg" alt=" line break" width=" 100%" height=" 3px" >
715
+ < img src=" https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/ docs/docs/assets/svg/line-gradient.svg" alt=" line break" width=" 100%" height=" 3px" >
716
716
717
717
# # Example Gallery
718
718
@@ -743,7 +743,7 @@ We invite developers to share their generated README files in our [Show & Tell][
743
743
744
744
Find additional README examples in our [examples directory][examples-directory] on GitHub.
745
745
746
- <img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="3px">
746
+ <img src="https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/ docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="3px">
747
747
748
748
## Roadmap
749
749
@@ -806,7 +806,7 @@ Released under the [MIT][license] license.
806
806
807
807
< /div>
808
808
809
- < img src=" docs/docs/assets/svg/line-gradient.svg" alt=" line break" width=" 100%" height=" 3px" >
809
+ < img src=" https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/ docs/docs/assets/svg/line-gradient.svg" alt=" line break" width=" 100%" height=" 3px" >
810
810
811
811
< ! -- REFERENCE LINKS -->
812
812
< ! -- README-AI RESOURCES -->
@@ -875,14 +875,14 @@ Released under the [MIT][license] license.
875
875
876
876
< ! -- EXAMPLES -->
877
877
< ! -- FEATURES -->
878
- [project-overview]: https://github.com/eli64s/readme-ai/blob/main/https://github.com/eli64s/readme-ai/blob/main/ docs/docs/assets/img/project-overview/introduction.png? raw=true
879
- [features-table]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/features/features.png
880
- [project-structure]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-structure/project-structure.png
881
- [project-index]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-structure/project-index.png
882
- [installation-steps]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/getting-started/installation-steps.png
883
- [usage-guides]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/getting-started/usage-guides.png
884
- [community-and-support]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/community/community-and-support.png
885
- [contributing-guidelines]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/community/contributing-guidelines.png
878
+ [project-overview]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-overview/introduction.png? raw=true
879
+ [features-table]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/features/features.png? raw=true
880
+ [project-structure]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-structure/project-structure.png? raw=true
881
+ [project-index]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-structure/project-index.png? raw=true
882
+ [installation-steps]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/getting-started/installation-steps.png? raw=true
883
+ [usage-guides]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/getting-started/usage-guides.png? raw=true
884
+ [community-and-support]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/community/community-and-support.png? raw=true
885
+ [contributing-guidelines]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/community/contributing-guidelines.png? raw=true
886
886
[readmeai.parsers]: https://github.com/eli64s/readme-ai/tree/main/readmeai/parsers
887
887
[tree.py]: https://github.com/eli64s/readme-ai/blob/main/readmeai/generators/tree.py
888
888
[prompts.toml]: https://github.com/eli64s/readme-ai/blob/main/readmeai/config/settings/prompts.toml
0 commit comments