docsify-action

KO | EN

gitlite — search

#python #hacktoberfest #llm #go #golang #android #rust #linux #java #windows #awesome #cli #vue #awesome-list

(★ 13)

📚 github action to automatically create awesome docs using docsify!

docsify-action 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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 !

docsify-action

docsify-action 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

docsify-action

docsify-action 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README