diff --git a/docs/customization/badges.md b/docs/customization/badges.md
index d1337341..fe6b86fd 100644
--- a/docs/customization/badges.md
+++ b/docs/customization/badges.md
@@ -1,6 +1,6 @@
# Badges
-A badge is a simple embeddable icon that displays various metrics such as the the number of stars or forks for a repository, languages used in the project, CI/CD build status, test coverage, the license of the project, and more. Badges are a great way to provide quick information about your project to users and visitors.
+A badge is a simple embeddable icon that displays various metrics such as the number of stars or forks for a repository, languages used in the project, CI/CD build status, test coverage, the license of the project, and more. Badges are a great way to provide quick information about your project to users and visitors.
README-AI offers various badge styles to enhance your project's README. This guide explains how to use and customize these badges.
@@ -8,36 +8,40 @@ README-AI offers various badge styles to enhance your project's README. This gui
Use the `--badge-style` option to select from the following styles:
-
+ 
## How It Works
@@ -45,64 +49,52 @@ README-AI automatically detects your project's dependencies and technologies dur
When you provide the `--badge-style` option to the `readmeai` command, two sets of badges are generated:
-1. **Default Metadata Badges**: The default set is always included in the generated README file. The default badges includes the project `license`, `last commit`, `top language`, and `total languages`.
+1. **Default Metadata Badges**: The default set is always included in the generated README file. The default badges include the project `license`, `last commit`, `top language`, and `total languages`.
2. **Project Dependency Badges**: When the `--badge-style` argument is provided to the CLI, a second badge set is generated, representing the extracted dependencies and metadata from your codebase.
-The badge sets are formatted in the README header, and provide the reader with a quick overview of the project's key metrics and technologies.
+The badge sets are formatted in the README header and provide the reader with a quick overview of the project's key metrics and technologies.
## Example Usage
Let's generate a README with custom badge colors and styles using the `--badge-color` and `--badge-style` options:
```bash
-readmeai --badge-color orange
- --badge-style flat-square
+readmeai --badge-color orange \
+ --badge-style flat-square \
--repository https://github.com/eli64s/readme-ai
```
The command above generates a README with the following badge configuration:
-
-
--
- {{ start_of_header }}
+!!! example
- {{ project_logo }}
+ === "Badge Generation"
- {{ project_name }}
+
+ 
+ 
+ 
+ 
- {{ project_slogan }}
+ *Built with the tools and technologies:*
-
-
-
-
-
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
- Built with the tools and technologies:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+The `--badge-color` option **only** modifies the default badge set, while the `--badge-style` option is applied to **both** the default and project dependency badges
- {{ end_of_header }}
-
-
-
-!!! note
- The `--badge-color` option **only** modifies the default badge set, while the `--badge-style` option is applied to **both** the default and project dependency badges.
## Tips for Using Badges
@@ -120,5 +112,6 @@ Thank you to the following projects for providing the badges used in this projec
- [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)
+```
---
diff --git a/docs/customization/header.md b/docs/customization/header.md
index ca43b704..014d0a26 100644
--- a/docs/customization/header.md
+++ b/docs/customization/header.md
@@ -58,6 +58,7 @@ The `--header-style` option supports the following values:
- **compact**: Left-aligned logo and a compact project title.
- **modern**: Right-aligned logo with a modern aesthetic for the header.
+
diff --git a/docs/customization/project_logo.md b/docs/customization/project_logo.md
index ee13c95d..f50773a2 100644
--- a/docs/customization/project_logo.md
+++ b/docs/customization/project_logo.md
@@ -6,32 +6,29 @@ A project logo is a visual representation of your project that appears at the to
Use the `--image` option to select from the following logo styles:
+=== "Blue"
-
+=== "Grey"
+
+ {: style="width:100px"}
## How It Works
@@ -67,7 +64,7 @@ You will be prompted to provide an image file path or URL:
Provide an image file path or URL:
```
-### Generating a Logo with LLM
+### LLM Generated Logo
To generate a logo using an LLM API (e.g., OpenAI), use the `--image llm` option:
@@ -81,28 +78,26 @@ This will generate a unique project logo using the specified LLM API.
Here's an example of how a generated README header might look with a logo:
-!!! example "Generated README Header with Logo"
-
- ```markdown
-
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
+