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(markdown): Add the 'Example' field to the markdown document parameter #972

Merged

Conversation

jasonkung22
Copy link
Contributor

Add the 'Example' field to the markdown document parameter

Change template ApiDoc.md and AllInOne.md,Add the 'Example' field to the markdown document parameter

Closes #971

Copy link

Thanks for your this PR. 🙏
Please check again for your PR changes whether contains any usage configuration change such as Add new configuration, Change default value of configuration.
If so, please add or update documents(markdown type) in docs/ for repository smart-doc-group/smart-doc-group.github.io

In addition, if you have added new features, please provide example code in the repository smart-doc-group/smart-doc-example-cn. This will help other users understand how to use the new features.


感谢您提交的PR。 🙏
请再次查看您的PR内容,确认是否包含任何使用方式 配置参数的变更,如:新增配置参数修改默认配置等操作。
如果是,请确保在提交之前,在仓库smart-doc-group/smart-doc-group.github.io中的docs/目录下添加或更新文档(markdown格式)。

另外,如果您添加了新功能,请在仓库smart-doc-group/smart-doc-example-cn中提供示例代码。这将帮助其他用户了解如何使用新功能。

…meter

Change template ApiDoc.md and AllInOne.md,Add the 'Example' field to the markdown document parameter

Closes TongchengOpenSource#971
@jasonkung22 jasonkung22 force-pushed the feat/markdown_example branch from 2d4f952 to 2e6eb3d Compare November 28, 2024 01:25
@shalousun shalousun merged commit 249c878 into TongchengOpenSource:master Nov 28, 2024
11 checks passed
@shalousun shalousun added this to the 3.10 milestone Nov 28, 2024
@shalousun shalousun added the enhancement New feature or request label Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The resulting markdown file does not contain the 'Example' field
2 participants