From e64cca4a827fb217196e44ab3d9d146af54cb0a3 Mon Sep 17 00:00:00 2001 From: Prince Chaddha Date: Tue, 5 Aug 2025 13:05:44 -0700 Subject: [PATCH 1/2] fixed workflow to update other readme files --- .github/scripts/update-readme.py | 9 +++++++++ .github/workflows/readme-update.yml | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/scripts/update-readme.py b/.github/scripts/update-readme.py index d5856174777..04f2264a0e8 100644 --- a/.github/scripts/update-readme.py +++ b/.github/scripts/update-readme.py @@ -18,6 +18,15 @@ if __name__ == "__main__": template = eval(open(".github/scripts/README.tmpl", "r").read()) print(template) + + # Update main README.md f = open("README.md", "w") f.write(template) f.close() + + # Update localized README files + readme_files = glob.glob("README_*.md") + for readme_file in readme_files: + f = open(readme_file, "w") + f.write(template) + f.close() diff --git a/.github/workflows/readme-update.yml b/.github/workflows/readme-update.yml index 611d553453f..e72a48b4b91 100644 --- a/.github/workflows/readme-update.yml +++ b/.github/workflows/readme-update.yml @@ -21,6 +21,6 @@ jobs: - uses: projectdiscovery/actions/setup/git@v1 - uses: projectdiscovery/actions/commit@v1 with: - files: 'README.md' + files: 'README.md README_*.md' message: 'docs: update README 🤖' - run: git push origin $GITHUB_REF From 92687f09ec6a29e6e1f7457073da64dfc3e96344 Mon Sep 17 00:00:00 2001 From: Prince Chaddha Date: Tue, 5 Aug 2025 17:25:39 -0700 Subject: [PATCH 2/2] added readme templates --- .github/scripts/README_CN.tmpl | 87 ++++++++++++++++++++++++++++++++ .github/scripts/README_JA.tmpl | 82 ++++++++++++++++++++++++++++++ .github/scripts/README_KR.tmpl | 84 ++++++++++++++++++++++++++++++ .github/scripts/update-readme.py | 22 +++++--- 4 files changed, 269 insertions(+), 6 deletions(-) create mode 100644 .github/scripts/README_CN.tmpl create mode 100644 .github/scripts/README_JA.tmpl create mode 100644 .github/scripts/README_KR.tmpl diff --git a/.github/scripts/README_CN.tmpl b/.github/scripts/README_CN.tmpl new file mode 100644 index 00000000000..208745e5b6e --- /dev/null +++ b/.github/scripts/README_CN.tmpl @@ -0,0 +1,87 @@ +f""" + +

+Nuclei 模板 +

+
+English | +简体中文 | +日本語 | +한국어 +
+

这个仓库用于存放由社区精心挑选的模板,可以使用nuclei引擎结合模板发现应用中的漏洞。

+ + +

+ + + + +

+ +

+ 文档 • + 贡献 • + 交流 • + 社区 • + FAQs • + 加入Discord +

+ +---- + +模板是 [nuclei 扫描器](https://github.com/projectdiscovery/nuclei) 的核心. +这个git仓库储存了由PD团队以及社区贡献的各种扫描模板. +我们希望您也能攻通过 **pull requests** 或者[Github issues](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+)来提交模板以扩大我们的仓库列表. + + +## Nuclei模板项目情况概述 + + +以下是nuclei模板项目的情况概览,包括唯一标签,作者,目录,严重性,模板类型的相关统计情况.以下表格列出了前面提到的每项情况的TOP10信息;你也可以点击[这里](TEMPLATES-STATS.md)查看详细信息.当然你也可以点击[这里](TEMPLATES-STATS.json)获取JSON格式的详细情况统计 + + + + + +
+ +{get_top10()} + +**{command("tree", -2, None)}**. + +
+ +📖 文档 +----- + +详细的文档请访问我们的网站[https://nuclei.projectdiscovery.io](https://nuclei.projectdiscovery.io),在我们网站的详细文档中,我们提供了如何创建模板的具体方法,并且也提供了相应的示例模板来帮助您更好地理解模板的开发以及运行原理. + +💪 贡献 +----- + +社区是Nuclei模板项目的主要贡献主力,我们非常欢迎开发者们来贡献模板,提出需求和报告Bug. + +![Alt](https://repobeats.axiom.co/api/embed/55ee65543bb9a0f9c797626c4e66d472a517d17c.svg "Repobeats analytics image") + +💬 交流 +----- + +如果您有任何关于该项目的疑问或是新奇的点子,欢迎在[Github discussions](https://github.com/projectdiscovery/nuclei-templates/discussions)创建新的板块来进行讨论. + +👨‍💻 社区 +----- + +欢迎您加入我们的[Discord 社区](https://discord.gg/projectdiscovery)，与项目维护人员直接讨论，或与其他人分享有关安全和自动化的想法。 +此外，您还可以在 [Twitter](https://twitter.com/pdnuclei) 上关注我们，了解 Nuclei 的最新动态。 + + +

+ + + +

+ + +最后,感谢您对这个项目的贡献,这将让我们的社区更加充满活力. +""" \ No newline at end of file diff --git a/.github/scripts/README_JA.tmpl b/.github/scripts/README_JA.tmpl new file mode 100644 index 00000000000..c9aca34dbdd --- /dev/null +++ b/.github/scripts/README_JA.tmpl @@ -0,0 +1,82 @@ +f"""

+Nuclei テンプレート +

+

アプリケーションのセキュリティ脆弱性を発見するためのNucleiエンジン用テンプレートのコミュニティキュレーションリスト

+ +

+ + + + +

+ +

+ ドキュメント • + 貢献 • + ディスカッション • + コミュニティ • + FAQs • + Discordに参加 +

+ +

+ English • + 한국어 • + 日本語 +

+ +---- + +テンプレートは、実際のスキャンエンジンを動作させる[nucleiスキャナー](https://github.com/projectdiscovery/nuclei)のコアです。 +このリポジトリは、私たちのチームが提供するテンプレートや、コミュニティからの貢献によるさまざまなテンプレートを保存・管理します。 +テンプレートのリストを増やすために、**プルリクエスト**や[Github issues](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+)を通じて貢献していただけると幸いです。 + +## Nuclei テンプレートの概要 + +Nucleiテンプレートプロジェクトの概要であり、ユニークなタグ、著者、ディレクトリ、重大度、テンプレートの種類に関する統計を含みます。以下の表は、各マトリックスのトップ10の統計を示しています。拡張バージョンは[こちら](TEMPLATES-STATS.md)で確認でき、[JSON](TEMPLATES-STATS.json)形式でも利用可能です。 + + + + + +
+ +{get_top10()} + +**{command("tree", -2, None)}**. + +
+ +📖 ドキュメント +----- + +新しいテンプレートやカスタムテンプレートを作成するための詳細なドキュメントは、https://nuclei.projectdiscovery.io で確認できます。作業方法を理解するためのテンプレートも用意しています。 + +💪 貢献 +----- + +Nucleiテンプレートはコミュニティの貢献によって動作します。 +[テンプレートの貢献](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+)、[機能リクエスト](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=feature_request.md&title=%5BFeature%5D+)、[バグ報告](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=bug_report.md&title=%5BBug%5D+)はいつでも歓迎します。 + +![Alt](https://repobeats.axiom.co/api/embed/55ee65543bb9a0f9c797626c4e66d472a517d17c.svg "Repobeats analytics image") + +💬 ディスカッション +----- + +質問、疑問、アイデアを話し合いたいですか？ +[Github discussions](https://github.com/projectdiscovery/nuclei-templates/discussions)で自由に始めることができます。 + +👨‍💻 コミュニティ +----- + +プロジェクトの管理者と直接話し合い、セキュリティや自動化に関することを他の人と共有するために、[Discord Community](https://discord.gg/projectdiscovery)に参加することを歓迎します。さらに、Nucleiに関するすべての情報を更新するために、[Twitter](https://twitter.com/pdnuclei)をフォローすることもできます。 + +

+ + + +

+ +皆さんの貢献とコミュニティの活性化への努力に感謝します。 +:heart: +""" \ No newline at end of file diff --git a/.github/scripts/README_KR.tmpl b/.github/scripts/README_KR.tmpl new file mode 100644 index 00000000000..c22e509d96d --- /dev/null +++ b/.github/scripts/README_KR.tmpl @@ -0,0 +1,84 @@ +f""" + +

+Nuclei 템플릿 +

+

커뮤니티에서 엄선한, 애플리케이션 보안 취약점을 찾기 위한 Nuclei 엔진용 템플릿 목록

+ + +

+ + + + +

+ +

+ 가이드 문서 • + 기여 • + 논의 • + 커뮤니티 • + FAQs • + 디스코드 +

+ +

+ English • + 한국어 +

+ +---- + +템플릿은 실제 스캐닝 엔진을 동작하게 하는 [nuclei scanner](https://github.com/projectdiscovery/nuclei)의 핵심입니다. +이 저장소는 우리 팀에서 제공하거나, 커뮤니티에서 기여한 다양한 템플릿들을 저장하고 보관합니다. +템플릿 목록을 증가시키기 위해서 **pull requests** 나 [Github issues](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+) 를 통해 기여해주시기를 부탁드립니다. + +## Nuclei 템플릿 개요 + +고유 태그, 작성자, 디렉토리, 심각도, 템플릿 종류에 대한 통계를 포함하고 있는 nuclei 템플릿의 개요입니다. 아래 표는 각 지표의 상위 10개 항목을 나타내고 있습니다. 더 자세한 정보는 [이곳](TEMPLATES-STATS.md)에서 확인 가능하고, [JSON](TEMPLATES-STATS.json) 형식으로도 확인 가능합니다. + + + + + +
+ +{get_top10()} + +**{command("tree", -2, None)}**. + +
+ +📖 문서 +----- + +새 템플릿이나 사용자 정의 템플릿을 빌드하기 위한 자세한 문서는 https://nuclei.projectdiscovery.io 에서 확인할 수 있습니다. 작업 방식의 이해를 돕기 위한 템플릿들도 있습니다. + +💪 기여 +----- + +Nuclei 템플릿은 커뮤니티의 기여로 동작합니다. +[템플릿 기여](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+), [기능 요청](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=feature_request.md&title=%5BFeature%5D+), [버그 제보](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=bug_report.md&title=%5BBug%5D+)는 언제든지 환영합니다. + +![Alt](https://repobeats.axiom.co/api/embed/55ee65543bb9a0f9c797626c4e66d472a517d17c.svg "Repobeats analytics image") + +💬 논의 +----- + +같이 이야기하고 싶은 질문, 의문 혹은 아이디어가 있으신가요? +[Github discussions](https://github.com/projectdiscovery/nuclei-templates/discussions) 에서 자유롭게 시작할 수 있습니다. + +👨‍💻 커뮤니티 +----- + +프로젝트 관리자와 직접 논의하고 보안과 자동화 관련 사항을 다른 사람과 공유하기 위해 [Discord Community](https://discord.gg/projectdiscovery) 에 참여하는 것을 환영합니다. 추가로 Nuclei 에 대한 모든 정보를 업데이트 하기 위해 [트위터](https://twitter.com/pdnuclei) 팔로우를 할 수 있습니다. + +

+ + + +

+ +여러분의 기여와 커뮤니티의 활성화를 위한 노력에 다시한번 감사드립니다. +:heart: +""" \ No newline at end of file diff --git a/.github/scripts/update-readme.py b/.github/scripts/update-readme.py index 04f2264a0e8..d7725d52581 100644 --- a/.github/scripts/update-readme.py +++ b/.github/scripts/update-readme.py @@ -24,9 +24,19 @@ if __name__ == "__main__": f.write(template) f.close() - # Update localized README files - readme_files = glob.glob("README_*.md") - for readme_file in readme_files: - f = open(readme_file, "w") - f.write(template) - f.close() + # Update localized README files with their respective templates + localized_files = { + "README_CN.md": ".github/scripts/README_CN.tmpl", + "README_JA.md": ".github/scripts/README_JA.tmpl", + "README_KR.md": ".github/scripts/README_KR.tmpl" + } + + for readme_file, template_file in localized_files.items(): + try: + localized_template = eval(open(template_file, "r").read()) + f = open(readme_file, "w") + f.write(localized_template) + f.close() + except FileNotFoundError: + print(f"Template {template_file} not found, skipping {readme_file}") + continue