|
1 | | -.PHONY: all update upgrade install_llvm install_clang install_bpftool install_go install_bpftrace set_path source_profile build generate clean |
| 1 | +.PHONY: all update upgrade install_llvm install_clang install_bpftool install_go install_bpftrace set_path source_profile build generate clean docs-install docs-serve docs-build docs-deploy docs-clean docs-help |
2 | 2 |
|
3 | 3 | install: update upgrade install_llvm install_clang install_go install_bpftrace install_bpftool set_path source_profile |
4 | 4 |
|
@@ -78,3 +78,45 @@ create-tool: |
78 | 78 | echo "3. Update Makefile generate target"; \ |
79 | 79 | echo "4. Update cmd/root.go to add the command"; \ |
80 | 80 | echo "5. Customize docs/tools/$$toolname.md" |
| 81 | + |
| 82 | +# Documentation targets |
| 83 | +docs-install: |
| 84 | + @echo "Installing MkDocs and dependencies..." |
| 85 | + pip3 install mkdocs-material |
| 86 | + pip3 install mkdocs-mermaid2-plugin |
| 87 | + @echo "✅ MkDocs installation complete" |
| 88 | + |
| 89 | +docs-serve: docs-install |
| 90 | + @echo "🚀 Starting MkDocs development server..." |
| 91 | + @echo "📖 Documentation will be available at: http://127.0.0.1:8000" |
| 92 | + @echo "📝 Edit files in docs/ and see changes in real-time" |
| 93 | + @echo "🛑 Press Ctrl+C to stop the server" |
| 94 | + mkdocs serve |
| 95 | + |
| 96 | +docs-build: docs-install |
| 97 | + @echo "🔨 Building static documentation..." |
| 98 | + mkdocs build |
| 99 | + @echo "✅ Documentation built in site/ directory" |
| 100 | + |
| 101 | +docs-deploy: docs-build |
| 102 | + @echo "🚀 Deploying documentation to GitHub Pages..." |
| 103 | + mkdocs gh-deploy --force |
| 104 | + @echo "✅ Documentation deployed successfully" |
| 105 | + |
| 106 | +docs-clean: |
| 107 | + @echo "🧹 Cleaning documentation build files..." |
| 108 | + rm -rf site/ |
| 109 | + @echo "✅ Documentation build files cleaned" |
| 110 | + |
| 111 | +# Help target for documentation |
| 112 | +docs-help: |
| 113 | + @echo "📚 Documentation Commands:" |
| 114 | + @echo "" |
| 115 | + @echo " make docs-install - Install MkDocs and dependencies" |
| 116 | + @echo " make docs-serve - Run local development server (http://127.0.0.1:8000)" |
| 117 | + @echo " make docs-build - Build static documentation" |
| 118 | + @echo " make docs-deploy - Deploy to GitHub Pages" |
| 119 | + @echo " make docs-clean - Clean build files" |
| 120 | + @echo " make docs-help - Show this help" |
| 121 | + @echo "" |
| 122 | + @echo "💡 Quick start: Run 'make docs-serve' to view docs locally" |
0 commit comments