https://github.com/tool3/docsify-action

📚 github action to automatically create awesome docs using docsify!
https://github.com/tool3/docsify-action

Last synced: about 1 year ago
JSON representation

📚 github action to automatically create awesome docs using docsify!

• Host: GitHub
• URL: https://github.com/tool3/docsify-action
• Owner: tool3
• License: mit
• Created: 2020-03-11T14:20:34.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-03T09:38:40.000Z (over 1 year ago)
• Last Synced: 2025-04-09T04:18:27.573Z (about 1 year ago)
• Language: TypeScript
• Homepage: https://tool3.github.io/docsify-action/
• Size: 1.52 MB
• Stars: 13
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# docsify-action 

github action that creates beautiful docs from your README!

# Create an action from this template

Click the `Use this Template` and provide the new repo details for your action

# Usage 

`docsify-action` allows you to quickly create beautiful docs from your existing `README` file.

```yaml

- uses: tool3/docsify-action@master

  with:

    github_token: ${{ secrets.GP_TOKEN }}

```

# Options

### `github_token`

   **required**   

   Github access token

### `dir`

  destination directory   

  default: `docs`

### `branch`

  destination branch   

  default: `master`

### `docsify_args`

  extra docsify-cli arguments   

### `commit_msg`

  commit message used when pushing to destination branch     

  default: `docs update 📚`

# Example

```yaml

name: docs

on: [push]

jobs:

  bump:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@master

    - uses: tool3/docsify-action@master

      with:

        github_token: ${{ secrets.GP_TOKEN }}

```

# Github Pages

instruct `github pages` to serve docs from `master` docs directory through your repository settings.   

Now you have self updating docs !