{"id":17242896,"url":"https://github.com/imcuttle/doc-md-import","last_synced_at":"2025-03-26T03:44:39.565Z","repository":{"id":24081639,"uuid":"100581569","full_name":"imcuttle/doc-md-import","owner":"imcuttle","description":"管理/同步 树状文档本地/服务器文章","archived":false,"fork":false,"pushed_at":"2022-01-07T14:05:57.000Z","size":86,"stargazers_count":0,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-23T02:33:59.375Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/imcuttle.png","metadata":{"files":{"readme":"Readme.md","changelog":"Changelog.md","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":"2017-08-17T08:40:35.000Z","updated_at":"2018-06-05T05:27:27.000Z","dependencies_parsed_at":"2022-07-27T04:32:10.166Z","dependency_job_id":null,"html_url":"https://github.com/imcuttle/doc-md-import","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fdoc-md-import","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fdoc-md-import/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fdoc-md-import/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fdoc-md-import/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imcuttle","download_url":"https://codeload.github.com/imcuttle/doc-md-import/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245585798,"owners_count":20639671,"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-10-15T06:14:20.984Z","updated_at":"2025-03-26T03:44:39.542Z","avatar_url":"https://github.com/imcuttle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# doc-pipe - 管理/同步 树状文档本地/服务器文章 解决方案\n\n## 画个饼\n\n1. doc-pipe 可以完成在本地完成对远端文档的同步和管理\n\n2. doc-pipe 自动化生成文章索引\n\n## 目前定位\n\n1. 十分适合个人文章(不可协同编辑)的管理和发布，实现本地到远端的同步。\n\n2. 如：个人standup、分享报告、总结...\n\n## 困境\n\n1. doc-pipe 使用原生 markdown 的列表、标题来形成树形结构，因此不会完全兼容树状文档的写法。\n\n2. 由于不完全兼容树状文档的分层逻辑，所以`tree \u003c-\u003e md`的转化不是互逆的。\n\n3. pull实现逻辑的复杂性\n\n4. 由于1的存在，故不适合于多人协同编辑文章的 远端-本地 同步\n\n## 安装使用\n\n```bash\nnpm install -g doc-md-import\ndoc-pipe -h\ndocin -h\n\n# 首先设置远端用户和密码\ndocin set-username abc\ndocin set-password\n# 进入到某文章工作目录\ncd my-doc\n# 初始化 doc-pipe\ndoc-pipe init\n# 将当前文件夹下所有以`.md` `.markdown`结尾的文件推送到远端\ndoc-pipe push\n# push `a/` 下的 md 文件\ndoc-pipe push a/\n# push `a/a.md` 文件\n# `-f` 表示强制 push\ndoc-pipe push a/a.md -f\n# 根据 push 记录生成索引 (./doc-pipe-toc.md) \n# `--push` 表示自动将 toc push 至远端\ndoc-pipe toc --push\n# 删除所有的 push 记录，同时也会删除远端的数据\ndoc-pipe rm\n# 删除之前提交的 `a/a.md` 记录\ndoc-pipe rm a/a.md\n# 查看当前的提交记录表\ndoc-pipe view\n```\n\n同时，可以利用下面的语法来对文章标题进行设置\n\n```\n---\ntitle: 我是标题\n---\n\n## 我是内容\n```\n\n## Todo\n\n- pull 的实现？\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimcuttle%2Fdoc-md-import","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimcuttle%2Fdoc-md-import","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimcuttle%2Fdoc-md-import/lists"}