feat: enable mkdocs to publish docs

cryptousersecurity · Sep 10, 2023 · cce447c · cce447c
1 parent de66099
commit cce447c
Show file tree

Hide file tree

Showing 21 changed files with 53 additions and 2 deletions.
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -0,0 +1,24 @@
+name: publish-docs
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force
diff --git a/README.md b/README.md
@@ -1 +1 @@
-# token-security-benchmark
+# Token Security Benchmark
diff --git a/docs/TSB-2023-001 Honeypot.md → docs/TSB-2023-001.md b/docs/TSB-2023-001 Honeypot.md → docs/TSB-2023-001.md
diff --git a/docs/TSB-2023-002 Mintable.md → docs/TSB-2023-002.md b/docs/TSB-2023-002 Mintable.md → docs/TSB-2023-002.md
diff --git a/docs/TSB-2023-003 OwnershipRetrieval.md → docs/TSB-2023-003.md b/docs/TSB-2023-003 OwnershipRetrieval.md → docs/TSB-2023-003.md
diff --git a/docs/TSB-2023-004 BalanceManipulation.md → docs/TSB-2023-004.md b/docs/TSB-2023-004 BalanceManipulation.md → docs/TSB-2023-004.md
diff --git a/docs/TSB-2023-005 HiddenOwnership.md → docs/TSB-2023-005.md b/docs/TSB-2023-005 HiddenOwnership.md → docs/TSB-2023-005.md
diff --git a/docs/TSB-2023-006 SelfDestruction.md → docs/TSB-2023-006.md b/docs/TSB-2023-006 SelfDestruction.md → docs/TSB-2023-006.md
diff --git a/docs/TSB-2023-007 ExternalInvocation.md → docs/TSB-2023-007.md b/docs/TSB-2023-007 ExternalInvocation.md → docs/TSB-2023-007.md
diff --git a/docs/TSB-2023-008 BlackListFunction.md → docs/TSB-2023-008.md b/docs/TSB-2023-008 BlackListFunction.md → docs/TSB-2023-008.md
diff --git a/docs/TSB-2023-009 FullSaleRestriction.md → docs/TSB-2023-009.md b/docs/TSB-2023-009 FullSaleRestriction.md → docs/TSB-2023-009.md
diff --git a/docs/TSB-2023-010 SlippageModification.md → docs/TSB-2023-010.md b/docs/TSB-2023-010 SlippageModification.md → docs/TSB-2023-010.md
diff --git a/docs/TSB-2023-011 TransferPausable.md → docs/TSB-2023-011.md b/docs/TSB-2023-011 TransferPausable.md → docs/TSB-2023-011.md
diff --git a/...-2023-012 PersonalSlippageModification.md → docs/TSB-2023-012.md b/...-2023-012 PersonalSlippageModification.md → docs/TSB-2023-012.md
diff --git a/docs/TSB-2023-013 TransactionWhitelisting.md → docs/TSB-2023-013.md b/docs/TSB-2023-013 TransactionWhitelisting.md → docs/TSB-2023-013.md
diff --git a/docs/TSB-2023-014 AntiWhale.md → docs/TSB-2023-014.md b/docs/TSB-2023-014 AntiWhale.md → docs/TSB-2023-014.md
diff --git a/docs/TSB-2023-015 AntiWhaleModification.md → docs/TSB-2023-015.md b/docs/TSB-2023-015 AntiWhaleModification.md → docs/TSB-2023-015.md
diff --git a/docs/TSB-2023-016 TradingCooldown.md → docs/TSB-2023-016.md b/docs/TSB-2023-016 TradingCooldown.md → docs/TSB-2023-016.md
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+# Token Security Benchmark
diff --git a/hack/gendocs/main.go b/hack/gendocs/main.go
@@ -63,7 +63,7 @@ func main() {
 			if err != nil {
 				log.Fatalf("failed to parse template: %v", err)
 			}
-			f, err := os.Create(filepath.Join("./docs", fmt.Sprintf("%s %s.md", item.ID, item.Name)))
+			f, err := os.Create(filepath.Join("./docs", fmt.Sprintf("%s.md", item.ID)))
 			if err != nil {
 				log.Fatalf("failed to create the docs file for risk item: %s, %v", item.ID, err)
 			}

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,26 @@
+site_name: Token Security Benchmark
+site_description: Token Security Benchmark
+repo_url: https://github.com/cryptousersecurity/token-security-benchmark
+strict: true
+theme:
+  name: "material"
+  language: en
+
+nav:
+  - Overview: index.md
+  - TSB-2023-001 Honeypot: TSB-2023-001.md
+  - TSB-2023-002 Mintable: TSB-2023-002.md
+  - TSB-2023-003 OwnershipRetrieval: TSB-2023-003.md
+  - TSB-2023-004 BalanceManipulation: TSB-2023-004.md
+  - TSB-2023-005 HiddenOwnership: TSB-2023-005.md
+  - TSB-2023-006 SelfDestruction: TSB-2023-006.md
+  - TSB-2023-007 ExternalInvocation: TSB-2023-007.md
+  - TSB-2023-008 BlackListFunction: TSB-2023-008.md
+  - TSB-2023-009 FullSaleRestriction: TSB-2023-009.md
+  - TSB-2023-010 SlippageModification: TSB-2023-010.md
+  - TSB-2023-011 TransferPausable: TSB-2023-011.md
+  - TSB-2023-012 PersonalSlippageModification: TSB-2023-012.md
+  - TSB-2023-013 TransactionWhitelisting: TSB-2023-013.md
+  - TSB-2023-014 AntiWhale: TSB-2023-014.md
+  - TSB-2023-015 AntiWhaleModification: TSB-2023-015.md
+  - TSB-2023-016 TradingCooldown: TSB-2023-016.md
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		# token-security-benchmark
		# Token Security Benchmark