Add a Reference section to the docs (#132) #115
This file contains 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
| name: Deploy to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - master | |
| # Review gh actions docs if you want to further define triggers, paths, etc | |
| # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on | |
| jobs: | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 16 | |
| cache: npm | |
| cache-dependency-path: documentation/package-lock.json | |
| - name: Install dependencies | |
| working-directory: documentation | |
| run: npm ci | |
| - name: Build documentation | |
| working-directory: documentation | |
| run: npm run build | |
| - name: Setup EnhanceDocs | |
| uses: enhancedocs/[email protected] | |
| with: | |
| # More about EnhanceDocs Secret API Key: https://docs.enhancedocs.com/security/api-keys | |
| api-key: ${{ secrets.ENHANCEDOCS_API_KEY }} | |
| # Popular action to deploy to GitHub Pages: | |
| # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| # Build output to publish to the `gh-pages` branch: | |
| publish_dir: ./documentation/build | |
| # The following lines assign commit authorship to the official | |
| # GH-Actions bot for deploys to `gh-pages` branch: | |
| # https://github.com/actions/checkout/issues/13#issuecomment-724415212 | |
| # The GH actions bot is used by default if you didn't specify the two fields. | |
| # You can swap them out with your own user credentials. | |
| user_name: github-actions[bot] | |
| user_email: 41898282+github-actions[bot]@users.noreply.github.com | |
| - name: Update EnhanceDocs Project | |
| run: enhancedocs alpha sources web --project 642ef48a9b7dab8fff36a55b https://wix-incubator.github.io/obsidian |