Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add github source code link in api docs #271

Merged
merged 1 commit into from
Apr 25, 2024
Merged

Conversation

hg-pyun
Copy link
Collaborator

@hg-pyun hg-pyun commented Apr 25, 2024

Summary

Add a code to link the source code so that you can see it directly in the API document.

Image

image

@hg-pyun hg-pyun self-assigned this Apr 25, 2024
@@ -7,6 +7,8 @@ import {
} from "@microsoft/api-documenter";
import { ApiItem } from "@microsoft/api-extractor-model";

import FunctionJson from "./function.json"; // Same file as /website/function.json. Used to judge path inside markdown-plugin, copy inside because of file path issue after build.
Copy link
Collaborator Author

@hg-pyun hg-pyun Apr 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's possible that this part will become a debt. When new methods are added, we need to fix both places, so we'll make sure that the improvement in this part is separately task.

Copy link
Member

@ppeeou ppeeou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍👍

@ppeeou ppeeou merged commit f7d63de into main Apr 25, 2024
1 check passed
@ppeeou ppeeou deleted the feat/docs-github-link branch April 25, 2024 02:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants