{"id":13623206,"url":"https://github.com/teadocs/teadocs","last_synced_at":"2025-04-13T04:10:37.864Z","repository":{"id":34153300,"uuid":"136801228","full_name":"teadocs/teadocs","owner":"teadocs","description":"Teadocs is a quick and easy WEB document setup tool","archived":false,"fork":false,"pushed_at":"2022-04-12T23:30:00.000Z","size":1416,"stargazers_count":153,"open_issues_count":12,"forks_count":30,"subscribers_count":5,"default_branch":"v0.x","last_synced_at":"2025-03-18T07:41:27.249Z","etag":null,"topics":["docker","docs-generator","documentation","nodejs"],"latest_commit_sha":null,"homepage":"http://docs.teadocs.cn/cn","language":"JavaScript","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/teadocs.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":"2018-06-10T11:00:29.000Z","updated_at":"2024-12-22T13:43:18.000Z","dependencies_parsed_at":"2022-08-08T00:01:37.493Z","dependency_job_id":null,"html_url":"https://github.com/teadocs/teadocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teadocs%2Fteadocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teadocs%2Fteadocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teadocs%2Fteadocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teadocs%2Fteadocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teadocs","download_url":"https://codeload.github.com/teadocs/teadocs/tar.gz/refs/heads/v0.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248661704,"owners_count":21141450,"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":["docker","docs-generator","documentation","nodejs"],"created_at":"2024-08-01T21:01:29.150Z","updated_at":"2025-04-13T04:10:37.839Z","avatar_url":"https://github.com/teadocs.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Teadocs\n\u003e Teadocs is a quick and easy WEB document setup tool.\n\n[![NPM](https://nodei.co/npm/teadocs.png)](https://nodei.co/npm/teadocs/)\n\n![npm](https://img.shields.io/npm/dw/teadocs.svg)\n![Bitbucket Pipelines](https://img.shields.io/bitbucket/pipelines/atlassian/adf-builder-javascript.svg)\n![GitHub top language](https://img.shields.io/github/languages/top/badges/shields.svg) \n![CocoaPods](https://img.shields.io/cocoapods/l/AFNetworking.svg)\n\n## 下一个版本 TODO\n\n- 更新说明文档（中文、英文）💪\n- dev 时候产生的目录改名为``.temp``，并且dev断开后自动删除该文件夹。💪\n- 自动递增端口 by dkvirus [#25](https://github.com/teadocs/teadocs/issues/25) 👍\n- tree.md 功能优化 by dkvirus [#24](https://github.com/teadocs/teadocs/issues/24) 👍\n- 增加单元测试/页面测试 😘\n- 函数/类增加完整注释说明 😘\n\n## Documentation\n\n- 中文: http://docs.teadocs.cn/cn\n- english: http://docs.teadocs.cn/en\n\n## Getting Started\n\n### installation\n\nPrerequisites: Nodejs(\u003e=8.0), npm version 3+.\n\n```\n$ npm install -g teadocs\n```\n\n### usage\n\n#### step 1\n\nInitialize a new document project\n\n```\n$ teadcos init mydocs\n```\n\n#### step 2\n\nGo to this folder\n\n```\n$ cd mydocs\n```\n\n#### step 3\n\nThis step is to enter the document editing mode, this mode will monitor the markdown file changes in real-time hot replacement of html pages.\n\n```\n$ teadocs dev\n```\n\n#### Automatically generate md\n\nIf you want to be lazy, you can run this command again. This command will automatically generate the relevant ``markdown file`` from ``tree.html``.\n\n```\n$ teadocs init\n```\n\n#### build docs\n\nBuild from ``./mydocs``\n```\n$ teadocs build\n```\n\n## LICENSE\n\nMIT License\n\nCopyright (c) 2019 ZhiBing(17560235@qq.com)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteadocs%2Fteadocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteadocs%2Fteadocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteadocs%2Fteadocs/lists"}