{"id":19345555,"url":"https://github.com/future-team/gfs-doc","last_synced_at":"2025-07-12T18:42:00.586Z","repository":{"id":57243369,"uuid":"66442363","full_name":"future-team/gfs-doc","owner":"future-team","description":null,"archived":false,"fork":false,"pushed_at":"2019-10-28T23:42:06.000Z","size":856,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-02-15T15:18:39.114Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/future-team.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":"2016-08-24T07:40:38.000Z","updated_at":"2017-08-07T10:06:09.000Z","dependencies_parsed_at":"2022-09-15T09:04:12.903Z","dependency_job_id":null,"html_url":"https://github.com/future-team/gfs-doc","commit_stats":null,"previous_names":["future-team/doc-builder"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/future-team%2Fgfs-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/future-team%2Fgfs-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/future-team%2Fgfs-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/future-team%2Fgfs-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/future-team","download_url":"https://codeload.github.com/future-team/gfs-doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240452187,"owners_count":19803581,"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-10T04:07:01.055Z","updated_at":"2025-02-24T09:27:56.013Z","avatar_url":"https://github.com/future-team.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"gfs-doc\n======================\n\n基于YUIDoc构建的Javascipt文档生成器，二次开发改造。 \n\n详细介绍见原作者博客: [JS文档和Demo自动化生成工具 - SmartDoc](http://www.cnblogs.com/zhh8077/p/4010991.html)和[注释编写说明](http://www.cnblogs.com/zhh8077/p/4011769.html)\n\n特性 \n--------------------\n    * 加入@demo配置项，看可以动态抓取html和js的内容作为@example，同时支持扩展@demo读取；支持@demo demo示例展示链接|demo源代码链接 写法\n    * 支持jasmine测试js文件的单元代码抓取为@example\n    * 实现多个example显示和tab切换\n    * 加入@show配置项来控制直接显示example效果\n    * 主题改版\n    * 去除@attribute属性设置，统一使用@property\n\n使用\n--------------------\n在目录中加入docConfig.js文件\n\n    npm install -g gfs-doc\n    gfsdoc\n\n\ndocConfig配置项说明\n---------------------\n\n    module.exports = {\n        //扫描的文件路径\n        paths: ['input/code/'],\n        //配置demo链接\n        demoUrl:'http://172.24.101.249:8000/input/demo/',\n        demoDir:\"input/demo/\",\n        //文档页面输出路径\n        outdir: 'doc/',\n        //内置主题\n        // theme:'ui',\n        //自定义主题目录\n        //themedir: 'theme-smart-ui/',\n        //项目信息配置\n        project: {\n            //项目名称\n            name: 'gfsdoc',\n            //项目描述，可以配置html，会生成到document主页\n            //description: '\u003ch2\u003eSmartDoc\u003c/h2\u003e \u003cp\u003eJavascript Document builder base on YUIDoc.\u003c/p\u003e',\n            //是否是移动设备平台\n            isApp:true,\n            //版本信息\n            version: '1.1.0',\n            //是否隐藏defined in 注解(代码定义于第几行)\n            //hideFoundAt:'true',\n            //是否禁止每个class里的methods、properties、events表格\n            //hideClassItemTable:'true',\n            //是否隐藏tab栏\n            //hideTabItemList:'true',\n            //hideViewDemo:'true',\n            //hideEditCode:'true',\n            //设置默认active的tab，不设置的话默认激活detail tab\n            //activeTab:'method',\n            //地址信息\n            url: 'https://github.com/future-team',\n            //主页面插入的js\n            //scripts:['uicode.js'],\n            //导航信息\n            navs: [{\n                name: \"首页\",\n                url: \"https://github.com/future-team\"\n            }, {\n                name: \"文档\",\n                url: \"index.html\"\n            }, {\n                name: \"关于\",\n                url: \"http://uedfamily.com/about/\"\n            }]\n        },\n        //demo页面需要加载的js库\n        demo: {\n            paths : ['input/code/ui/uicode.js'],\n            link : ['http://code.jquery.com/jquery-1.11.0.min.js'] \n        }\n    };\n    \n\n其他使用见 [YUIDoc](http://yui.github.com/yuidoc/)\n\n\n\n例子使用说明\n------------------\n将代码下载后，运行\n\n    npm install\n    node test.js\n\n\n程序会将input/目录下的js扫描，将Document生成到doc/目录下,运行doc/index.html,即可访问生成的文档。\n\n\n注意：生成后的代码编辑页面需要发布到服务器才能正常运行；\n\n[API地址](http://zhh77.github.io/smartjs/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffuture-team%2Fgfs-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffuture-team%2Fgfs-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffuture-team%2Fgfs-doc/lists"}