{"id":21832674,"url":"https://github.com/tool3/docsify-action","last_synced_at":"2025-04-14T07:37:27.144Z","repository":{"id":37056211,"uuid":"246591521","full_name":"tool3/docsify-action","owner":"tool3","description":"📚 github action to automatically create awesome docs using docsify!","archived":false,"fork":false,"pushed_at":"2024-11-03T09:38:40.000Z","size":1594,"stargazers_count":13,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T04:18:27.573Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://tool3.github.io/docsify-action/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tool3.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-11T14:20:34.000Z","updated_at":"2025-01-23T21:07:31.000Z","dependencies_parsed_at":"2023-02-10T06:45:16.233Z","dependency_job_id":"b7702b67-732c-48c8-97cb-22da6b27a8fe","html_url":"https://github.com/tool3/docsify-action","commit_stats":{"total_commits":144,"total_committers":4,"mean_commits":36.0,"dds":0.5277777777777778,"last_synced_commit":"d3e4c2f3992d28758f031f1c4f3099cf517b81ca"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":"tool3/publisher","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tool3%2Fdocsify-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tool3%2Fdocsify-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tool3%2Fdocsify-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tool3%2Fdocsify-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tool3","download_url":"https://codeload.github.com/tool3/docsify-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248840503,"owners_count":21169999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-27T19:24:49.557Z","updated_at":"2025-04-14T07:37:27.117Z","avatar_url":"https://github.com/tool3.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docsify-action \ngithub action that creates beautiful docs from your README!\n\n# Create an action from this template\nClick the `Use this Template` and provide the new repo details for your action\n\n# Usage \n`docsify-action` allows you to quickly create beautiful docs from your existing `README` file.\n```yaml\n- uses: tool3/docsify-action@master\n  with:\n    github_token: ${{ secrets.GP_TOKEN }}\n```\n\n# Options\n### `github_token`\n   **required**   \n   Github access token\n### `dir`\n  destination directory   \n  default: `docs`\n### `branch`\n  destination branch   \n  default: `master`\n### `docsify_args`\n  extra docsify-cli arguments   \n### `commit_msg`\n  commit message used when pushing to destination branch     \n  default: `docs update 📚`\n\n# Example\n```yaml\nname: docs\n\non: [push]\n\njobs:\n  bump:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@master\n    - uses: tool3/docsify-action@master\n      with:\n        github_token: ${{ secrets.GP_TOKEN }}\n```\n\n# Github Pages\ninstruct `github pages` to serve docs from `master` docs directory through your repository settings.   \nNow you have self updating docs !","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftool3%2Fdocsify-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftool3%2Fdocsify-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftool3%2Fdocsify-action/lists"}