https://github.com/XAMPPRocky/deploy-mdbook

A GitHub Action to automatically build and deploy your mdbook project.
https://github.com/XAMPPRocky/deploy-mdbook

Last synced: 2 months ago
JSON representation

A GitHub Action to automatically build and deploy your mdbook project.

• Host: GitHub
• URL: https://github.com/XAMPPRocky/deploy-mdbook
• Owner: XAMPPRocky
• License: mit
• Created: 2020-02-19T14:48:27.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-26T04:01:40.000Z (almost 2 years ago)
• Last Synced: 2024-11-04T14:46:26.273Z (3 months ago)
• Language: TypeScript
• Size: 2.95 MB
• Stars: 29
• Watchers: 3
• Forks: 1
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# 📘 deploy-mdbook

The `deploy-mdbook` action allows you to easily build and deploy your mdBook project to GitHub

Pages. See [`action.yml`] for configuration options.

[`action.yml`]: ./action.yml

## Example

```yaml

name: Deploy mdBook

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - uses: XAMPPRocky/[email protected]

        with:

            token: ${{ secrets.GITHUB_TOKEN }}

```

## Development

The action is written in NodeJS 12, and you can install the dependencies with:

```

npm install

```

### Running

```

npm start

```

GitHub Actions requires all the dependencies to be committed, so before

creating a commit you need to run:

```

npm run build

```

The command will bundle everything in `dist/index.js`. That file will need to

be committed.