Files
sim/scripts/setup-doc-generator.sh
Waleed Latif 54e1439224 feat(docs): added script to auto-generate docs for integrations/tools (#293)
* added scaffolding for auto-generating docs for integrations based on block definition, get rendering error for mdx pages

* page renders, have to add more useful information

* standardized tool naming convention, added script to autogenerate docs for integrations, added docs for each tool

* re-generated docs, updated CONTRIBUTING.md to reflect new format

* added a dedicated tools page

* added additional information for tools, added manual section logic to docs producer

* added a link back to sim studio, fixed z level issue on mobile, added better intro

* updated script to more accurately reflect the params for each tool, as well as the overall blocks' output
2025-04-22 20:04:21 -07:00

49 lines
1.2 KiB
Bash
Executable File

#!/bin/bash
# Get the scripts directory path
SCRIPTS_DIR=$(dirname "$0")
cd "$SCRIPTS_DIR"
echo "Working in scripts directory: $(pwd)"
echo "Setting up documentation generator..."
# Create package.json for scripts directory
cat > package.json << EOF
{
"name": "sim-doc-generator",
"version": "1.0.0",
"description": "Documentation generator for Sim Studio blocks",
"type": "module",
"private": true
}
EOF
# Install dependencies local to scripts directory
npm install --save-dev typescript @types/node @types/react ts-node tsx glob
# Setup tsconfig.json
cat > tsconfig.json << EOF
{
"compilerOptions": {
"target": "ES2020",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true,
"resolveJsonModule": true,
"noEmit": true,
"allowImportingTsExtensions": true
},
"ts-node": {
"esm": true,
"experimentalSpecifierResolution": "node"
},
"include": ["./**/*.ts"]
}
EOF
echo "Dependencies installed successfully!"
echo "You can now run './scripts/generate-docs.sh' to generate the documentation."