{"id":26483819,"url":"https://github.com/chatopera/docsbot","last_synced_at":"2026-04-14T14:32:35.799Z","repository":{"id":57681704,"uuid":"432684843","full_name":"chatopera/docsbot","owner":"chatopera","description":"Chatopera 文档中心助手","archived":false,"fork":false,"pushed_at":"2022-04-29T05:33:05.000Z","size":23,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-29T12:22:54.356Z","etag":null,"topics":["chatbot"],"latest_commit_sha":null,"homepage":"https://docs.chatopera.com/","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chatopera.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}},"created_at":"2021-11-28T10:47:16.000Z","updated_at":"2022-05-06T07:02:58.000Z","dependencies_parsed_at":"2022-09-03T19:51:40.721Z","dependency_job_id":null,"html_url":"https://github.com/chatopera/docsbot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/chatopera/docsbot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chatopera%2Fdocsbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chatopera%2Fdocsbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chatopera%2Fdocsbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chatopera%2Fdocsbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chatopera","download_url":"https://codeload.github.com/chatopera/docsbot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chatopera%2Fdocsbot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31801340,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T11:13:53.975Z","status":"ssl_error","status_checked_at":"2026-04-14T11:13:53.299Z","response_time":153,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["chatbot"],"created_at":"2025-03-20T04:58:10.821Z","updated_at":"2026-04-14T14:32:35.772Z","avatar_url":"https://github.com/chatopera.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chatopera Docs BOT\r\n\r\nDocumentation as a Chatbot. You know, for chat.\r\n\r\n[Demo](https://oh-my.cskefu.com/im/text/0e8xuk.html)\r\n\r\n![image](https://user-images.githubusercontent.com/3538629/165872617-4528090d-c662-4d9a-b60c-db8340625b14.png)\r\n\r\n## Featured\r\n\r\n* Parse local markdown docs inside directory recursivly, generate FAQs File for Chatopera BOT Platform.\r\n\r\n* Further import into a BOT on Chatopera, details in [doc](https://dwz.chatopera.com/754yr1).\r\n\r\n## Install\r\n\r\nPublish on npmjs, [link](https://www.npmjs.com/package/@chatopera/docsbot).\r\n\r\n```\r\nnpm install -g @chatopera/docsbot\r\n```\r\n\r\nNow, `docsbot` is available in CLI path.\r\n\r\n## Usage\r\n\r\n```\r\ndocsbot --baseurl $BASE_URL \\\r\n    -i $DOCS_HOME \\\r\n    -f $DOCS_FOLDERS \\\r\n    -o $FAQ_OUTOUT\r\n```\r\n\r\n| Key | Sample | Description |\r\n| --- | --- | --- |\r\n| `BASE_URL` | `https://docs.chatopera.com/products/` | conjunction for the per doc page link  |\r\n| `DOCS_HOME` | `~/chatopera/docs/docfx_project/products` | Docs root dir |\r\n| `DOCS_FOLDERS` | `chatbot-platform,cskefu` | Child dirs to be parsed in root dir |\r\n| `FAQ_OUTPUT_FILE` | `./tmp/bot.faq.json` | Generated file in Chatopera BOT FAQ Format |\r\n\r\nAssume your docs folders are like this, and docs site are at \u003chttps://docs.chatopera.com/products/\u003e:\r\n\r\n```\r\n$DOCS_HOME(Root dir)\r\n└───chatbot-platform\r\n    |───appendix\r\n    |───contract\r\n    |───explanations\r\n    |───howto-guides\r\n    |───references\r\n    │   ├───func-builtin\r\n    │   └───sdk\r\n    │       ├───chatbot\r\n    │       └───chatopera\r\n    └───tutorials\r\n```\r\n\r\nThen, the Docs link address of `$DOCS_HOME/chatbot-platform/appendix/index.md` would be interpreted as `https://docs.chatopera.com/products/chatbot-platform/appendix/index.html`.\r\n\r\nThis docs are also hosted [on GitHub](https://github.com/chatopera/docs).\r\n\r\n* baseurl: set with command line\r\n* docfoler: iterater with `DOCS_FOLDER`, split by `,`\r\n* filepath: the markdown files in each `docfoler`, where extension `.md` is replaced with `.html`\r\n\r\n## Upload into Chatopera BOT Platform\r\n\r\nInstall Chatopera SDK for `bot` CLI.\r\n\r\n```\r\nnpm install -g @chatopera/sdk\r\n```\r\n\r\nTouch .env\r\n\r\n```\r\n# Chatopera BOT Service endpoint\r\nBASE_URL=https://docs.chatopera.com/products/\r\nBOT_PROVIDER=https://bot.chatopera.com\r\nBOT_CLIENT_ID=xx\r\nBOT_CLIENT_SECRET=xx\r\nBOT_ACCESS_TOKEN=\r\n# BOT_FAQ_FILE is generated by docsbot\r\nBOT_FAQ_FILE=bot.faq.json\r\n```\r\n\r\nRun the job\r\n\r\n```\r\nsource .env\r\nbot faq -a import -f ./$BOT_FAQ_FILE\r\n```\r\n\r\n### Others\r\n\r\n```\r\ndocsbot --help\r\n```\r\n\r\n## Development\r\n\r\n```\r\nnpm install\r\nnode bin/cmd.js --help\r\ncp sample.env .env\r\n./scripts/dev.sh\r\n```\r\n\r\n## License\r\n\r\n[Apache2](./LICENSE)\r\n\r\n[![chatoper banner][co-banner-image]][co-url]\r\n\r\n[co-banner-image]: https://user-images.githubusercontent.com/3538629/42383104-da925942-8168-11e8-8195-868d5fcec170.png\r\n[co-url]: https://docs.chatopera.com\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchatopera%2Fdocsbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchatopera%2Fdocsbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchatopera%2Fdocsbot/lists"}