docs: Add Quick Start section to README.md #8
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # @format | |
| name: Deploy Docs to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main # Trigger on pushes to the main branch | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write # Grant write permission to GITHUB_TOKEN | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: '22' # Use a stable Node.js version | |
| - name: Install dependencies | |
| run: npm install | |
| - name: Build Documentation | |
| run: | | |
| # Assuming your documentation is in the 'docs' directory | |
| # and you want to use a static site generator or just copy files. | |
| # For simple markdown files, you might just copy them. | |
| # For more complex docs, you might use a tool like VitePress, Docusaurus, etc. | |
| # Since we just have markdown files, we'll just ensure they are in a deployable state. | |
| echo "Building documentation..." | |
| # No specific build step for raw markdown, just ensure 'docs' exists. | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs # The directory containing your built documentation | |
| # If you have a custom domain, uncomment and set: | |
| # cname: example.com |