{"id":15363281,"url":"https://github.com/topthinking/techsum","last_synced_at":"2025-08-30T20:14:09.849Z","repository":{"id":138492607,"uuid":"270302295","full_name":"Topthinking/techsum","owner":"Topthinking","description":"基于award框架的轻文档系统","archived":false,"fork":false,"pushed_at":"2020-06-14T14:53:11.000Z","size":144,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-21T01:41:18.900Z","etag":null,"topics":["award","blog","technical-summary"],"latest_commit_sha":null,"homepage":"http://topthinking.github.io/techsum","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/Topthinking.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-07T12:39:02.000Z","updated_at":"2020-08-13T10:42:32.000Z","dependencies_parsed_at":"2023-07-20T04:03:12.075Z","dependency_job_id":null,"html_url":"https://github.com/Topthinking/techsum","commit_stats":null,"previous_names":["topthinking/award-blog"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Topthinking/techsum","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Topthinking%2Ftechsum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Topthinking%2Ftechsum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Topthinking%2Ftechsum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Topthinking%2Ftechsum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Topthinking","download_url":"https://codeload.github.com/Topthinking/techsum/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Topthinking%2Ftechsum/sbom","scorecard":{"id":143098,"data":{"date":"2025-08-11","repo":{"name":"github.com/Topthinking/techsum","commit":"caa984650304b2b5e4f54b9fa465dae632821153"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-16T08:39:04.459Z","repository_id":138492607,"created_at":"2025-08-16T08:39:04.459Z","updated_at":"2025-08-16T08:39:04.459Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272900164,"owners_count":25012034,"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","status":"online","status_checked_at":"2025-08-30T02:00:09.474Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["award","blog","technical-summary"],"created_at":"2024-10-01T13:05:13.766Z","updated_at":"2025-08-30T20:14:09.826Z","avatar_url":"https://github.com/Topthinking.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Technical Summary ∙ [![version](https://img.shields.io/npm/v/techsum.svg)](https://www.npmjs.com/package/techsum)\n\n## 基于[`award`](https://github.com/XimalayaCloud/award)框架的文档摘要站点\n\n## 功能\n\n- 支持静态资源部署\n- 支持离线搜索\n- 支持拼音搜索\n- 检索关键词，快速定位\n- 采用npm包形式部署，修改版本号即可一键升级新功能\n\n## 使用说明\n\n- 创建文档文件夹`demo`\n\n- `cd demo`\n\n- 初始化\n\n  ```\n  $ yarn init -y\n  $ yarn add techsum\n  ```\n\n- 根目录创建`docs`文件夹，存放如下结构的 MD 文档\n\n  ```\n  # 通用\n\n  ## techsum\n  - 关键字：techsum\n  - 负责人：孙杨杰\n  - 文档：https://github.com/Topthinking/techsum\n  ```\n\n- 根目录创建`.yaml`文件\n\n   ```yaml\n   # 当前静态资源前缀，可以存放cdn资源\n   assetPrefixs: /\n   \n   # 当前页面logo\n   logo: https://github.com/fluidicon.png\n   \n   # 当前项目名称\n   name: 名字描述\n   \n   # 当前项目描述\n   description: 描述\n   \n   # 添加文案地址\n   add: https://github.com/Topthinking/techsum/issues/issues/1\n   \n   # 添加描述\n   addDesc: 快速添加您的技术摘要\n   \n   # 编辑文案地址\n   edit: https://github.com/Topthinking/techsum/issues/edit/master\n   \n   # 当前仓库地址\n   gitlab: https://github.com/Topthinking/techsum\n   \n   # 当前存储key\n   localStorage: qd-guide\n   \n   # pipeline:\n   #   url:\n   #   img:\n   \n   # 引导页是否使用按钮点击过渡\n   guide-button: 1\n   \n   ```\n\n- 启动开发命令`yarn ts dev`\n\n- 启动编译导出命令`yarn ts build`，导出目录为`public`\n\n## 贡献指南\n\n```shell\n#1. 克隆仓库\n$ git clone git@github.com:Topthinking/techsum.git\n\n#2. 安装依赖\n$ yarn\n\n#3. 启动页面开发\n$ yarn dev\n\n#4. 启动编译导出\n$ yarn build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftopthinking%2Ftechsum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftopthinking%2Ftechsum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftopthinking%2Ftechsum/lists"}