CLI और स्क्रिप्ट्स
कमांड लाइन टूल्स और बिल्ड ऑटोमेशन
DocTunes स्टैटिक डॉक्यूमेंटेशन सूट को स्थानीय रूप से और CI/CD पाइपलाइनों में बनाने, परीक्षण करने, लिंट करने और सर्व करने के लिए आपको जो कुछ भी चाहिए।
npm run devnpm स्क्रिप्ट
हॉट रीलोडिंग के साथ पोर्ट 3000 पर स्थानीय डेवलपमेंट सर्वर शुरू करता है।
बैश
npm run devnpm run buildnpm स्क्रिप्ट
सभी 20 पृष्ठों को स्टैटिक HTML में संकलित करता है और out/ sitemap.xml बनाता है।
बैश
npm run buildnpm run lintnpm स्क्रिप्ट
सभी TypeScript और React घटकों में ESLint निष्पादित करता है।
बैश
npm run lintnpx serve outnpm स्क्रिप्ट
सत्यापन के लिए स्थानीय रूप से स्टैटिक प्रोडक्शन out डायरेक्टरी को सर्व करता है।
बैश
npx serve out -p 8080GitHub Actions स्टैटिक डिप्लॉय वर्कफ़्लो
इस वर्कफ़्लो को जोड़ें .github/workflows/deploy.yml हर पुश पर GitHub Pages या S3 पर स्वचालित स्टैटिक डिप्लॉयमेंट के लिए:
yaml
name: Deploy Static Documentation
on:
push:
branches: [main]
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm ci
- run: npm run build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./out