{"id":18620732,"url":"https://github.com/stars-one/doc-generator","last_synced_at":"2025-11-03T12:30:25.626Z","repository":{"id":37259877,"uuid":"272205654","full_name":"stars-one/Doc-Generator","owner":"stars-one","description":"为个人开发者打造的快速文档生成器","archived":false,"fork":false,"pushed_at":"2022-06-20T22:45:56.000Z","size":18123,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-27T04:26:16.673Z","etag":null,"topics":["commonmark-java","freemaker","javafx-8","tornadofx"],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stars-one.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-14T13:15:58.000Z","updated_at":"2020-11-20T07:33:03.000Z","dependencies_parsed_at":"2022-08-22T12:21:10.881Z","dependency_job_id":null,"html_url":"https://github.com/stars-one/Doc-Generator","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/stars-one%2FDoc-Generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stars-one%2FDoc-Generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stars-one%2FDoc-Generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stars-one%2FDoc-Generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stars-one","download_url":"https://codeload.github.com/stars-one/Doc-Generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239414094,"owners_count":19634370,"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":["commonmark-java","freemaker","javafx-8","tornadofx"],"created_at":"2024-11-07T04:07:49.473Z","updated_at":"2025-11-03T12:30:25.581Z","avatar_url":"https://github.com/stars-one.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 文档生成器\n\n可以快速生成静态页面文档的工具,适用于文档翻译或者是个人项目,个人开发者可以快速将生成的静态页面部署在gitee或者github上\n\n## 优点\n- **规范**\t\n使用流行的markdown格式编写文档\n- **美观**\t\n页面设计采用Material Design风格\n- **简洁**\t\n无需安装与配置node.js等环境,安装jre环境后即可打开软件\n- **使用简单,快速部署**\t\n只需要输入相关信息即可快速生成静态页面并部署在gitee或github上\n## 截图\n\n![](https://img2020.cnblogs.com/blog/1210268/202006/1210268-20200615165436918-1832558961.png)\n\n生成的文档页面截图:\n\n![](https://img2020.cnblogs.com/blog/1210268/202006/1210268-20200615170913181-1954315625.png)\n## 使用\n### 1.安装JRE环境\n如果你是Java开发人员,确保安装有JDK8环境,如果不是开发人员,请下载JRE8安装包文件,这里我只提供windows版本(其他版本可自行到官网下载)\n\n[JRE windows64位安装包下载地址](https://wwa.lanzous.com/i8zQ6df5dgh)\n\n安装完之后即可双击jar包即可打开软件\n\n[软件jar包下载地址](https://wwa.lanzous.com/b0cqalxxg)\n\n或者下载out目录下的jar包\n\n### 2.输入信息\n\n点击\"添加大章节按钮\"即可新增一个大章节,之后批量选择md文件,并修改对应的标题,输入信息如下图所示\n\n![](https://img2020.cnblogs.com/blog/1210268/202006/1210268-20200615165436918-1832558961.png)\n\n之后点击\"生成静态资源文件\"按钮,即可在jar包当前目录生成doc的文件夹,用浏览器打开`index.html`即可看到界面,如下图所示\n\n![](https://img2020.cnblogs.com/blog/1210268/202006/1210268-20200615170913181-1954315625.png)\n\n\n## 部署\n部署可部署在Gitee或者是Github上,或者部署到你自己的项目中,**新手还是建议部署在Gitee上**\n### 1.页面部署到Gitee\n\n将项目路径复制到你的开发项目中,之后推送到Gitee,打开你项目对应的Gitee地址,点击服务菜单,选择Page服务\n\n![](https://img2020.cnblogs.com/blog/1210268/202006/1210268-20200615171934157-2027483693.png)\n\n选择文档所在的目录,之后等待即可部署\n\n![](https://img2020.cnblogs.com/blog/1210268/202006/1210268-20200615172111237-799538900.png)\n\n之后即可通过网址访问到你具体的项目\n\n### 2.页面部署到Github(待补充)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstars-one%2Fdoc-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstars-one%2Fdoc-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstars-one%2Fdoc-generator/lists"}