Fix markdown

nvuillam · nvuillam · commit febdbf424605 · 2025-09-20T10:08:19.000+02:00
diff --git a/docs/llm-advisor.md b/docs/llm-advisor.md
@@ -279,16 +279,19 @@ Example fix:
 ### Common Issues
 
 1. **"LLM Advisor not available"**
+
    - Check that `LLM_ADVISOR_ENABLED: true`
    - Verify LangChain dependencies are installed
    - Ensure API keys are set correctly
 
 2. **"Failed to initialize LLM"**
+
    - Verify API key is valid and has sufficient credits
    - Check internet connection for cloud providers
    - For Ollama, ensure the service is running locally
 
 3. **No suggestions generated**
+
    - Check if errors were detected by linters
    - Verify the linter output format is parseable
    - Review logs for parsing errors
diff --git a/docs/llm-provider/llm_provider_anthropic.md b/docs/llm-provider/llm_provider_anthropic.md
@@ -12,19 +12,19 @@ Anthropic's Claude models excel at code analysis with a strong focus on safety a
 
 2. **Set Environment Variable**:
 
-   ```bash
-   export ANTHROPIC_API_KEY=sk-ant-your-api-key
-   ```
+```bash
+export ANTHROPIC_API_KEY=sk-ant-your-api-key
+```
 
 3. **Configure MegaLinter**:
 
-   ```yaml
-   LLM_ADVISOR_ENABLED: true
-   LLM_PROVIDER: anthropic
-   LLM_MODEL_NAME: claude-3-7-sonnet-latest
-   LLM_MAX_TOKENS: 1000
-   LLM_TEMPERATURE: 0.1
-   ```
+```yaml
+LLM_ADVISOR_ENABLED: true
+LLM_PROVIDER: anthropic
+LLM_MODEL_NAME: claude-3-7-sonnet-latest
+LLM_MAX_TOKENS: 1000
+LLM_TEMPERATURE: 0.1
+```
 
 ## Official Model List
 
@@ -56,16 +56,19 @@ ANTHROPIC_API_VERSION: 2023-06-01
 ### Common Issues
 
 1. **"Invalid API key"**
+
    - Verify API key format: `sk-ant-...`
    - Check account status and credits
    - Ensure API access is enabled
 
 2. **"Rate limit exceeded"**
+
    - Anthropic has generous rate limits
    - Implement exponential backoff
    - Contact support for higher limits
 
 3. **"Context too long"**
+
    - Claude handles very large contexts well
    - Consider reducing file context if needed
    - Use appropriate model for your needs
diff --git a/docs/llm-provider/llm_provider_deepseek.md b/docs/llm-provider/llm_provider_deepseek.md
@@ -12,19 +12,19 @@ DeepSeek offers specialized code-focused models at competitive prices, optimized
 
 2. **Set Environment Variable**:
 
-   ```bash
-   export DEEPSEEK_API_KEY=your-deepseek-api-key
-   ```
+```bash
+export DEEPSEEK_API_KEY=your-deepseek-api-key
+```
 
 3. **Configure MegaLinter**:
 
-   ```yaml
-   LLM_ADVISOR_ENABLED: true
-   LLM_PROVIDER: deepseek
-   LLM_MODEL_NAME: deepseek-chat
-   LLM_MAX_TOKENS: 1000
-   LLM_TEMPERATURE: 0.1
-   ```
+```yaml
+LLM_ADVISOR_ENABLED: true
+LLM_PROVIDER: deepseek
+LLM_MODEL_NAME: deepseek-chat
+LLM_MAX_TOKENS: 1000
+LLM_TEMPERATURE: 0.1
+```
 
 ## Official Model List
 
@@ -53,16 +53,19 @@ DEEPSEEK_BASE_URL: https://api.deepseek.com/v1
 ### Common Issues
 
 1. **"Invalid API key"**
+
    - Verify your API key is correct
    - Check account status and credits
    - Ensure API access is enabled
 
 2. **"Rate limit exceeded"**
+
    - Check your plan's rate limits
    - Implement rate limiting in your requests
    - Consider upgrading your plan
 
 3. **"Model not available"**
+
    - Verify model name is correct
    - Check if model is available in your region
    - Some models may require special access
diff --git a/docs/llm-provider/llm_provider_google_genai.md b/docs/llm-provider/llm_provider_google_genai.md
@@ -15,19 +15,19 @@ Google's Gemini models offer excellent performance at competitive prices with st
 
 2. **Set Environment Variable**:
 
-   ```bash
-   export GOOGLE_API_KEY=AIza-your-api-key
-   ```
+```bash
+export GOOGLE_API_KEY=AIza-your-api-key
+```
 
 3. **Configure MegaLinter**:
 
-   ```yaml
-   LLM_ADVISOR_ENABLED: true
-   LLM_PROVIDER: google
-   LLM_MODEL_NAME: gemini-2.5-flash
-   LLM_MAX_TOKENS: 1000
-   LLM_TEMPERATURE: 0.1
-   ```
+```yaml
+LLM_ADVISOR_ENABLED: true
+LLM_PROVIDER: google
+LLM_MODEL_NAME: gemini-2.5-flash
+LLM_MAX_TOKENS: 1000
+LLM_TEMPERATURE: 0.1
+```
 
 ## Official Model List
 
@@ -56,16 +56,19 @@ GOOGLE_APPLICATION_CREDENTIALS: /path/to/service-account.json
 ### Common Issues
 
 1. **"API key not valid"**
+
    - Verify API key format: `AIza...`
    - Check that Generative AI API is enabled
    - Ensure you're in a supported region
 
 2. **"Quota exceeded"**
+
    - Check your quota limits in Google Cloud Console
    - Request quota increases if needed
    - Implement rate limiting
 
 3. **"Model not found"**
+
    - Verify model name is correct
    - Check regional availability
    - Some models may require special access
diff --git a/docs/llm-provider/llm_provider_grok.md b/docs/llm-provider/llm_provider_grok.md
@@ -12,19 +12,19 @@ Grok is xAI's conversational AI model, designed for real-time information and en
 
 2. **Set Environment Variable**:
 
-   ```bash
-   export GROK_API_KEY=your-grok-api-key
-   ```
+```bash
+export GROK_API_KEY=your-grok-api-key
+```
 
 3. **Configure MegaLinter**:
 
-   ```yaml
-   LLM_ADVISOR_ENABLED: true
-   LLM_PROVIDER: grok
-   LLM_MODEL_NAME: grok-3-mini
-   LLM_MAX_TOKENS: 1000
-   LLM_TEMPERATURE: 0.1
-   ```
+```yaml
+LLM_ADVISOR_ENABLED: true
+LLM_PROVIDER: grok
+LLM_MODEL_NAME: grok-3-mini
+LLM_MAX_TOKENS: 1000
+LLM_TEMPERATURE: 0.1
+```
 
 ## Official Model List
 
diff --git a/docs/llm-provider/llm_provider_huggingface.md b/docs/llm-provider/llm_provider_huggingface.md
@@ -20,24 +20,25 @@ pip install langchain-huggingface transformers torch
 ### Configuration
 
 1. **Optional: Get API Token** (for private models or hosted inference):
+
    - Go to [Hugging Face Settings](https://huggingface.co/settings/tokens)
    - Create a new token
 
 2. **Set Environment Variable** (optional):
 
-   ```bash
-   export HUGGINGFACE_API_TOKEN=hf_your-token
-   ```
+```bash
+export HUGGINGFACE_API_TOKEN=hf_your-token
+```
 
 3. **Configure MegaLinter**:
 
-   ```yaml
-   LLM_ADVISOR_ENABLED: true
-   LLM_PROVIDER: huggingface
-   LLM_MODEL_NAME: microsoft/DialoGPT-medium
-   LLM_MAX_TOKENS: 1000
-   LLM_TEMPERATURE: 0.1
-   ```
+```yaml
+LLM_ADVISOR_ENABLED: true
+LLM_PROVIDER: huggingface
+LLM_MODEL_NAME: microsoft/DialoGPT-medium
+LLM_MAX_TOKENS: 1000
+LLM_TEMPERATURE: 0.1
+```
 
 ## Official Model List
 
diff --git a/docs/llm-provider/llm_provider_mistralai.md b/docs/llm-provider/llm_provider_mistralai.md
@@ -12,19 +12,19 @@ Mistral AI provides high-quality language models with European data residency an
 
 2. **Set Environment Variable**:
 
-   ```bash
-   export MISTRAL_API_KEY=your-mistral-api-key
-   ```
+```bash
+export MISTRAL_API_KEY=your-mistral-api-key
+```
 
 3. **Configure MegaLinter**:
 
-   ```yaml
-   LLM_ADVISOR_ENABLED: true
-   LLM_PROVIDER: mistral
-   LLM_MODEL_NAME: mistral-small-latest
-   LLM_MAX_TOKENS: 1000
-   LLM_TEMPERATURE: 0.1
-   ```
+```yaml
+LLM_ADVISOR_ENABLED: true
+LLM_PROVIDER: mistral
+LLM_MODEL_NAME: mistral-small-latest
+LLM_MAX_TOKENS: 1000
+LLM_TEMPERATURE: 0.1
+```
 
 ## Official Model List
 
@@ -53,16 +53,19 @@ MISTRAL_BASE_URL: https://api.mistral.ai
 ### Common Issues
 
 1. **"Authentication failed"**
+
    - Verify your API key is correct
    - Check account status and credits
    - Ensure proper permissions
 
 2. **"Rate limit exceeded"**
+
    - Check your plan's limits
    - Implement exponential backoff
    - Contact support for higher limits
 
 3. **"Model not found"**
+
    - Use latest model names
    - Check availability in your region
    - Verify spelling and format
diff --git a/docs/llm-provider/llm_provider_ollama.md b/docs/llm-provider/llm_provider_ollama.md
@@ -66,21 +66,25 @@ OLLAMA_BASE_URL: http://your-server:11434
 ### Common Issues
 
 1. **"Connection refused"**
+
    - Ensure Ollama is running: `ollama serve`
    - Check the correct port (default: 11434)
    - Verify firewall settings
 
 2. **"Model not found"**
+
    - Pull the model first: `ollama pull model-name`
    - List available models: `ollama list`
    - Use exact model name with tag
 
 3. **"Out of memory"**
+
    - Use smaller models (7B instead of 13B)
    - Close other applications
    - Consider using quantized models
 
 4. **Slow responses**
+
    - Use smaller models for faster inference
    - Ensure sufficient RAM
    - Consider GPU acceleration if available
diff --git a/docs/llm-provider/llm_provider_openai.md b/docs/llm-provider/llm_provider_openai.md
@@ -12,19 +12,19 @@ OpenAI provides state-of-the-art language models offering excellent code analysi
 
 2. **Set Environment Variable**:
 
-   ```bash
-   export OPENAI_API_KEY=sk-your-api-key-here
-   ```
+```bash
+export OPENAI_API_KEY=sk-your-api-key-here
+```
 
 3. **Configure MegaLinter**:
 
-   ```yaml
-   LLM_ADVISOR_ENABLED: true
-   LLM_PROVIDER: openai
-   LLM_MODEL_NAME: gpt-4.1-mini
-   LLM_MAX_TOKENS: 1000
-   LLM_TEMPERATURE: 0.1
-   ```
+```yaml
+LLM_ADVISOR_ENABLED: true
+LLM_PROVIDER: openai
+LLM_MODEL_NAME: gpt-4.1-mini
+LLM_MAX_TOKENS: 1000
+LLM_TEMPERATURE: 0.1
+```
 
 ## Official Model List
 
@@ -56,16 +56,19 @@ OPENAI_ORGANIZATION: org-your-org-id
 ### Common Issues
 
 1. **"Invalid API key"**
+
    - Verify your API key is correct
    - Check that your account has available credits
    - Ensure the key has proper permissions
 
 2. **"Rate limit exceeded"**
+
    - Reduce concurrent requests
    - Upgrade to a higher tier plan
    - Implement retry logic
 
 3. **"Model not found"**
+
    - Verify the model name is correct
    - Check if you have access to the model
    - Some models require special access
