name: "Check markdown links"

on:
  push:
    branches:
      - master
  pull_request:
  workflow_dispatch:

permissions: {}

jobs:
  check-links:
    permissions:
      contents: read
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Check links
        uses: lycheeverse/lychee-action@v2.8.0
        with:
          # excluded:

        }
    }

    /**
     * Renders markdown text to sanitized HTML.
     *
     * @param markdown the markdown text to render
     * @return sanitized HTML string
     */
    public String render(final String markdown) {
        if (markdown == null || markdown.isEmpty()) {
            return "";
        }

        try {
            // Parse markdown to AST

            if page.file.src_path.startswith(excluded_section):
                return markdown
        missing_translation_content = get_missing_translation_content(config.docs_dir)
        header = ""
        body = markdown
        if markdown.startswith("#"):
            header, _, body = markdown.partition("\n\n")
        return f"{header}\n\n{missing_translation_content}\n\n{body}"

    public void test_render_paragraphWithLineBreak() {
        String markdown = "Line 1  \nLine 2";
        String result = markdownRenderer.render(markdown);
        // Two spaces at end of line creates a line break
        assertTrue(result.contains("<br"));
    }

    @Test
    public void test_render_specialHtmlEntities() {
        String markdown = "Less than < and greater than > and ampersand &";

{* ../../docs_src/dependencies/tutorial013_an_py310.py ln[30:38] hl[31:33] *}



# Links { #links }

## Markdown-style links { #markdown-style-links }

This is a [Markdown link](https://example.com) to an external site.

This is a link with attributes: [**FastAPI** Project Generators](project-generation.md){.internal-link target=_blank}

| `title` | `str` | The title of the API. |
| `summary` | `str` | A short summary of the API. <small>Available since OpenAPI 3.1.0, FastAPI 0.99.0.</small> |
| `description` | `str` | A short description of the API. It can use Markdown. |
| `version` | `string` | The version of the API. This is the version of your own application, not of OpenAPI. For example `2.5.0`. |

* `description`：一個 `str`，為該標籤的簡短描述。可使用 Markdown，並會顯示在文件介面中。
* `externalDocs`：一個 `dict`，描述外部文件，包含：
    * `description`：一個 `str`，外部文件的簡短描述。
    * `url`（**必填**）：一個 `str`，外部文件的 URL。

### 建立標籤的中繼資料 { #create-metadata-for-tags }

我們用 `users` 與 `items` 兩個標籤來示範。

先為你的標籤建立中繼資料，然後將它傳給 `openapi_tags` 參數：

{* ../../docs_src/metadata/tutorial004_py310.py hl[3:16,18] *}

注意你可以在描述中使用 Markdown，例如「login」會以粗體（**login**）顯示，而「fancy」會以斜體（_fancy_）顯示。

        }
      }
    ```

### Posting a String ([.kt][PostStringKotlin], [.java][PostStringJava])

Use an HTTP POST to send a request body to a service. This example posts a markdown document to a web service that renders markdown as HTML. Because the entire request body is in memory simultaneously, avoid posting large (greater than 1 MiB) documents using this API.

=== ":material-language-kotlin: Kotlin"
    ```kotlin

        modified_text[line_no] = f"{hashes} {title}{permalink}"

    return modified_text


# Markdown links
# --------------------------------------------------------------------------------------


def extract_markdown_links(lines: list[str]) -> list[MarkdownLinkInfo]:
    """
    Extract all markdown links from the given lines.

    Return list of MarkdownLinkInfo, where each dict contains:

- `description`：一个 `str`，该标签的简短描述。可以使用 Markdown，并会显示在文档 UI 中。
- `externalDocs`：一个 `dict`，描述外部文档，包含：
    - `description`：一个 `str`，该外部文档的简短描述。
    - `url`（必填）：一个 `str`，该外部文档的 URL。

### 创建标签元数据 { #create-metadata-for-tags }

让我们在带有标签的示例中为 `users` 和 `items` 试一下。

创建标签元数据并把它传递给 `openapi_tags` 参数：

{* ../../docs_src/metadata/tutorial004_py310.py hl[3:16,18] *}

注意你可以在描述内使用 Markdown，例如「login」会显示为粗体（**login**）以及「fancy」会显示为斜体（_fancy_）。