eigent icon indicating copy to clipboard operation
eigent copied to clipboard

[BUG] Lint Markdown Run Failed

Open Douglasymlai opened this issue 4 weeks ago • 0 comments

What version of eigent are you using?

0.0.73

System information

Image

Lint Markdown Check Failed.

Problem description

Read.me document needed update

The job failed due to Markdown linting errors in README.md. The main issues are:

  1. Lines longer than 80 characters (MD013).

  2. Use of inline HTML elements (MD033), such as
    ,

    , , , ,
    , .
  3. Headings or lists not surrounded by blank lines (MD022, MD032).

  4. Trailing spaces (MD009).

  5. Missing image alt-text (MD045). 6.The failure in the CI job originates from linting issues in Unused or duplicate link/image references (MD053). 7 the README.md file. Specifically:

  6. Excessive Line Lengths:

    • Many lines exceed the maximum allowed length of 80 characters (e.g., lines 210, . Bare URLs (MD034213, 217, etc.).
  7. Inline HTML Usage:

    • The file contains disallowed inline HTML tags, such as <) and table style issues (MD060). 8br>, <kbd>, <details>, <div>, <summary>,. Multiple consecutive blank lines (MD012).
  8. To <strong>, and <img>.

    1. Blank Lines Around Headings fix the failing job and Lists:
      • Headings and lists need to:
    • Break up lines longer than 80 characters.
    • be surrounded by one blank line (e.g., lines 262, Replace inline HTML tags with standard Markdown where possible. For example 311).
    1. Trailing Spaces: :
    • Use - Lines such as 268 and 368 contain unnecessary trailing spaces.
    1. Markdown headings, lists, and blockquotes instead of <details Missing Alt Text for Images:
      • Images such as <>, <img> tags lack alternate text attributes.

    6summary>, etc.

    • For keyboard keys,. Issues in Table Style:
    • Some table pipes use backticks: Ctrl+C instead of in the columns are misaligned or have extra spaces.

    Recommended Fixes:

    1. ** CtrlBreaking Long Lines**:
      • Ensure that lines do not exceed 80 characters.+C
      .
    • For example:
      Analyze the UK healthcare industry to Use support the planning of my next Markdown images with alt-text: ![alt text](image_url).
      
    • company...
      should be split neatly into Ensure lists and headings shorter lines.
      
      
    1. **Replace or Remove Inline HTML have a blank line before and after.
    • Remove**: Convert inline HTML tags into Markdown alternatives trailing spaces from lines.
    • Remove duplicate and unused image/link or remove them. For example:
      • Replace <br> with two line breaks.
      • Replace <strong> with ** for bold text.
        Before: references at the bottom.
        
    • Avoid bare URLs; use Markdown link format: Prompt: After: Prompt: ``email. `
    1. Add Blank Lines:

      • Ensure there- Ensure’s a blank line surrounding headings and lists for Markdown tables follow style guidelines linting.
    2. Remove Trailing Spaces: (consistent spacing around pipes).

    • Eliminate multiple - Eliminate any trailing spaces at the end of lines.

    blank lines (leave5. Add Alt Text to Images:

    • Add descriptive only onealt attributes to all images. For instance:
      
      

    Example fix for a section:

    markdown
         ![Description of the image](image-url### Backend
    
    - **Framework:** Fast)
         ```
    
    6. **Fix Table Alignment**:
       - Adjust the spacing to make tables consistent, e.g., no extra spaces beforeAPI
    
    Some description here.
    
    ![Backend architecture diagram](diagram or after pipes.
    
    ### Example Fix in `README.md`:
    
    Before:
    ```markdown
    <div align="center"><a name="readme-top"></a>
    [![][image-head]][eigent-site.png)
    
    ]
    [![][discord-image]][discord-url]<br>
    

    After: Contact: [email protected]

    Check and apply similar corrections throughout README.md. If you need the```markdown
    **Center-aligned Content**
    ![Head Image][ raw file or help fixing a specific section, leteigent-site]
    ![Discord Badge][discord-url]
    `` me know!`
    
    This will address the issues raised by the linter. You can refer to the full `README.md` [here](https://github
    
    ### log
    
    [logs_52573522679.zip](https://github.com/user-attachments/files/24238295/logs_52573522679.zip)
    
    ### Additional context
    
    _No response_
    

Douglasymlai avatar Dec 18 '25 14:12 Douglasymlai