diff --git a/.github/workflows/GHPages.yml b/.github/workflows/GHPages.yml index 3008ef14..4173da68 100644 --- a/.github/workflows/GHPages.yml +++ b/.github/workflows/GHPages.yml @@ -12,54 +12,7 @@ jobs: - uses: actions/setup-node@v4 - uses: docker://pandoc/latex:2.9 with: - args: "pandoc ./documents/forJava/Javaコーディング規約.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/Javaコーディング規約.html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forJava/Javaコーディング規約.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/Javaコーディング規約.docx" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forSQL/SQLコーディング規約(Oracle).md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/SQLコーディング規約(Oracle).html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forSQL/SQLコーディング規約(Oracle).md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/SQLコーディング規約(Oracle).docx" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forSQL/SQLコーディング規約(PostgreSQL).md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/SQLコーディング規約(PostgreSQL).html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forSQL/SQLコーディング規約(PostgreSQL).md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/SQLコーディング規約(PostgreSQL).docx" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forAWSResource/AWSインフラリソース命名規約.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/AWSインフラリソース命名規約.html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forAWSResource/AWSインフラリソース命名規約.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/AWSインフラリソース命名規約.docx" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/OpenAPI_Specification_2.0.html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/OpenAPI_Specification_2.0.docx" - - name: Copy img directory - run: cp -r ./documents/forGitBranch/img ./img - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forGitBranch/git_branch_standards.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/Gitブランチフロー規約.html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forGitBranch/git_branch_standards.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/Gitブランチフロー規約.docx" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forMarkdown/markdown_design_document.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/Markdown設計ドキュメント規約.html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forMarkdown/markdown_design_document.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/Markdown設計ドキュメント規約.docx" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forSlack/slack_usage_guidelines.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/Slack利用ガイドライン.html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forSlack/slack_usage_guidelines.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/Slack利用ガイドライン.docx" + args: sh build-resources-with-pandoc.sh - name: Install Packages run: | npm i -f @@ -67,7 +20,6 @@ jobs: - name: Build all run: | npm run build - npm run copy - name: Deploy uses: peaceiris/actions-gh-pages@v4 with: diff --git a/.github/workflows/test-build-resources-with-pandoc.yml b/.github/workflows/test-build-resources-with-pandoc.yml new file mode 100644 index 00000000..3398838d --- /dev/null +++ b/.github/workflows/test-build-resources-with-pandoc.yml @@ -0,0 +1,25 @@ +name: build-resources-with-pandoc + +on: + push: + branches: + - "*" # matches every branch that doesn't contain a '/' + - "*/*" # matches every branch containing a single '/' + - "**" # matches every branch + - "!master" # excludes master + +jobs: + build-resources-with-pandoc: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + - uses: docker://pandoc/latex:2.9 + with: + args: sh build-resources-with-pandoc.sh + - name: Archive resources + uses: actions/upload-artifact@v4 + with: + name: pandoc_resources + path: ./public/resources/ + retention-days: 1 diff --git a/.github/workflows/test-pandoc-resources.yml b/.github/workflows/test-pandoc-resources.yml deleted file mode 100644 index 93732cf0..00000000 --- a/.github/workflows/test-pandoc-resources.yml +++ /dev/null @@ -1,52 +0,0 @@ -name: test-pandoc-resources - -on: - push: - branches: - - "*" # matches every branch that doesn't contain a '/' - - "*/*" # matches every branch containing a single '/' - - "**" # matches every branch - - "!master" # excludes master - -jobs: - build-docs-docs: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-node@v4 - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forJava/Javaコーディング規約.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/Javaコーディング規約.html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forJava/Javaコーディング規約.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/Javaコーディング規約.docx" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forSQL/SQLコーディング規約(Oracle).md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/SQLコーディング規約(Oracle).html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forSQL/SQLコーディング規約(Oracle).md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/SQLコーディング規約(Oracle).docx" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forSQL/SQLコーディング規約(PostgreSQL).md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/SQLコーディング規約(PostgreSQL).html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forSQL/SQLコーディング規約(PostgreSQL).md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/SQLコーディング規約(PostgreSQL).docx" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forAWSResource/AWSインフラリソース命名規約.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/AWSインフラリソース命名規約.html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forAWSResource/AWSインフラリソース命名規約.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/AWSインフラリソース命名規約.docx" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./public/resources/OpenAPI_Specification_2.0.html" - - uses: docker://pandoc/latex:2.9 - with: - args: "pandoc ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./public/resources/OpenAPI_Specification_2.0.docx" - - name: Archive resources - uses: actions/upload-artifact@v4 - with: - name: pandoc_resources - path: ./public/resources/ - retention-days: 1 diff --git a/build-resources-with-pandoc.sh b/build-resources-with-pandoc.sh new file mode 100644 index 00000000..96b5ec52 --- /dev/null +++ b/build-resources-with-pandoc.sh @@ -0,0 +1,48 @@ +ROOT_DIR=`pwd` +CSS_PATH="${ROOT_DIR}/documents/common/pandoc_styles/css/style.css" +STYLE_DOCX_PATH="${ROOT_DIR}/documents/common/pandoc_styles/スタイル.docx" +RESOURCES_DIR="${ROOT_DIR}/public/resources" + +# Java +cd ${ROOT_DIR}/documents/forJava + +pandoc ./Javaコーディング規約.md -s --self-contained --number-sections --toc -t html5 -c ${CSS_PATH} -o ${RESOURCES_DIR}/Javaコーディング規約.html +pandoc ./Javaコーディング規約.md --toc --reference-doc=${STYLE_DOCX_PATH} -s -o ${RESOURCES_DIR}/Javaコーディング規約.docx + +# SQL +cd ${ROOT_DIR}/documents/forSQL + +pandoc ./SQLコーディング規約(Oracle).md -s --self-contained --number-sections --toc -t html5 -c ${CSS_PATH} -o ${RESOURCES_DIR}/SQLコーディング規約(Oracle).html +pandoc ./SQLコーディング規約(Oracle).md --toc --reference-doc=${STYLE_DOCX_PATH} -s -o ${RESOURCES_DIR}/SQLコーディング規約(Oracle).docx +pandoc ./SQLコーディング規約(PostgreSQL).md -s --self-contained --number-sections --toc -t html5 -c ${CSS_PATH} -o ${RESOURCES_DIR}/SQLコーディング規約(PostgreSQL).html +pandoc ./SQLコーディング規約(PostgreSQL).md --toc --reference-doc=${STYLE_DOCX_PATH} -s -o ${RESOURCES_DIR}/SQLコーディング規約(PostgreSQL).docx + +# AWSインフラリソース +cd ${ROOT_DIR}/documents/forAWSResource + +pandoc ./AWSインフラリソース命名規約.md -s --self-contained --number-sections --toc -t html5 -c ${CSS_PATH} -o ${RESOURCES_DIR}/AWSインフラリソース命名規約.html +pandoc ./AWSインフラリソース命名規約.md --toc --reference-doc=${STYLE_DOCX_PATH} -s -o ${RESOURCES_DIR}/AWSインフラリソース命名規約.docx + +# OpenAPISpecification +cd ${ROOT_DIR}/documents/forOpenAPISpecification + +pandoc ./OpenAPI_Specification_2.0.md -s --self-contained --number-sections --toc -t html5 -c ${CSS_PATH} -o ${RESOURCES_DIR}/OpenAPI_Specification_2.0.html +pandoc ./OpenAPI_Specification_2.0.md --toc --reference-doc=${STYLE_DOCX_PATH} -s -o ${RESOURCES_DIR}/OpenAPI_Specification_2.0.docx + +# Git +cd ${ROOT_DIR}/documents/forGitBranch + +pandoc ./git_branch_standards.md -s --self-contained --number-sections --toc -t html5 -c ${CSS_PATH} -o ${RESOURCES_DIR}/Gitブランチフロー規約.html +pandoc ./git_branch_standards.md --toc --reference-doc=${STYLE_DOCX_PATH} -s -o ${RESOURCES_DIR}/Gitブランチフロー規約.docx + +# Markdown +cd ${ROOT_DIR}/documents/forMarkdown + +pandoc ./markdown_design_document.md -s --self-contained --number-sections --toc -t html5 -c ${CSS_PATH} -o ${RESOURCES_DIR}/Markdown設計ドキュメント規約.html +pandoc ./markdown_design_document.md --toc --reference-doc=${STYLE_DOCX_PATH} -s -o ${RESOURCES_DIR}/Markdown設計ドキュメント規約.docx + +# Slack +cd ${ROOT_DIR}/documents/forSlack + +pandoc ./slack_usage_guidelines.md -s --self-contained --number-sections --toc -t html5 -c ${CSS_PATH} -o ${RESOURCES_DIR}/Slack利用ガイドライン.html +pandoc ./slack_usage_guidelines.md --toc --reference-doc=${STYLE_DOCX_PATH} -s -o ${RESOURCES_DIR}/Slack利用ガイドライン.docx diff --git a/package.json b/package.json index 602f60c1..b1d8aded 100644 --- a/package.json +++ b/package.json @@ -6,28 +6,10 @@ "scripts": { "watch": "vitepress dev . --open", "build": "vitepress build .", - "install": "npm install --global mermaid-filter", "lint": "npm run lint:format && npm run lint:js", "lint:js": "eslint . .vitepress", "lint:format": "prettier . --list-different", - "copy": "npm-run-all copy:*", - "copy:git": "cp -r documents/forGitBranch/img docs/documents/forGitBranch/img", - "copy:markdown": "cp -r documents/forMarkdown/future_muscle_partner/docs/future_muscle_partner_abstract.png docs/documents/forMarkdown/future_muscle_partner/docs/future_muscle_partner_abstract.png", - "format": "prettier . --write", - "pandoc": "npm-run-all pandoc:*", - "pandoc:java-html": "pandoc ./documents/forJava/Javaコーディング規約.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./documents/forJava/Javaコーディング規約.html", - "pandoc:java-word": "pandoc ./documents/forJava/Javaコーディング規約.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./documents/forJava/Javaコーディング規約.docx", - "pandoc:sqlo-html": "pandoc ./documents/forSQL/SQLコーディング規約(Oracle).md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./documents/forSQL/SQLコーディング規約(Oracle).html", - "pandoc:sqlo-word": "pandoc ./documents/forSQL/SQLコーディング規約(Oracle).md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./documents/forSQL/SQLコーディング規約(Oracle).docx", - "pandoc:awsresource-html": "pandoc ./documents/forAWSResource/AWSインフラリソース命名規約.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./documents/forAWSResource/AWSインフラリソース命名規約.html", - "pandoc:awsresource-word": "pandoc ./documents/forAWSResource/AWSインフラリソース命名規約.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./documents/forAWSResource/AWSインフラリソース命名規約.docx", - "pandoc:swagger-html": "pandoc ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0.md -s --self-contained --number-sections --toc -t html5 -F mermaid-filter.cmd -c ./documents/common/pandoc_styles/css/style.css -o ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0規約.html", - "pandoc:swagger-word": "pandoc ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -F mermaid-filter.cmd -s -o ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0規約.docx", - "pandoc:gitbranch-html": "pandoc ./documents/forGitBranch/git_branch_standards.md -s --self-contained --number-sections --toc -t html5 -F mermaid-filter.cmd -c ./documents/common/pandoc_styles/css/style.css -o ./documents/forGitBranch/Gitブランチフロー.html", - "pandoc:gitbranch-word": "pandoc ./documents/forGitBranch/git_branch_standards.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -F mermaid-filter.cmd -s -o ./documents/forGitBranch/Gitブランチフロー.docx", - "pandoc:markdown-html": "pandoc ./documents/forMarkdown/README.md -s --self-contained --number-sections --toc -t html5 -F mermaid-filter.cmd -c ./documents/common/pandoc_styles/css/style.css -o ./documents/forMarkdown/Markdown設計ドキュメント規約.html", - "pandoc:markdown-word": "pandoc ./documents/forMarkdown/README.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -F mermaid-filter.cmd -s -o ./documents/forMarkdown/Markdown設計ドキュメント規約.docx", - "pandoc:slack-html": "pandoc ./documents/forSlack/README.md -s --self-contained --number-sections --toc -t html5 -F mermaid-filter.cmd -c ./documents/common/pandoc_styles/css/style.css -o ./documents/forSlack/Slack利用ガイドライン.html" + "format": "prettier . --write" }, "repository": { "type": "git ",