{"id":31700370,"url":"https://github.com/1panel-dev/cloudexplorer-docs","last_synced_at":"2025-10-08T20:37:59.922Z","repository":{"id":153289904,"uuid":"623344880","full_name":"1Panel-dev/CloudExplorer-docs","owner":"1Panel-dev","description":"CloudExplore 项目的官方文档","archived":false,"fork":false,"pushed_at":"2025-09-16T07:13:33.000Z","size":274329,"stargazers_count":10,"open_issues_count":0,"forks_count":6,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-09-16T08:39:23.989Z","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":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/1Panel-dev.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-04-04T07:27:16.000Z","updated_at":"2025-09-16T07:13:36.000Z","dependencies_parsed_at":"2023-05-19T07:18:43.621Z","dependency_job_id":"24a8a3cd-4d0a-4acd-a017-c9005056f2af","html_url":"https://github.com/1Panel-dev/CloudExplorer-docs","commit_stats":null,"previous_names":["1panel-dev/cloudexplorer-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/1Panel-dev/CloudExplorer-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1Panel-dev%2FCloudExplorer-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1Panel-dev%2FCloudExplorer-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1Panel-dev%2FCloudExplorer-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1Panel-dev%2FCloudExplorer-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/1Panel-dev","download_url":"https://codeload.github.com/1Panel-dev/CloudExplorer-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1Panel-dev%2FCloudExplorer-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000638,"owners_count":26082818,"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-10-08T02:00:06.501Z","response_time":56,"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":[],"created_at":"2025-10-08T20:37:58.390Z","updated_at":"2025-10-08T20:37:59.913Z","avatar_url":"https://github.com/1Panel-dev.png","language":"JavaScript","readme":"## 本地开发\n\n### 克隆本仓库\n\n```bash\ngit clone https://github.com/1Panel-dev/CloudExplorer-docs\n```\n\n### 安装依赖\n\n```bash\ncd docs\npip install -r requirements/requirements.txt\n```\n\n### 修改文档内容\n\n本文档的文档结构定义在 `mkdocs.yml` 文件中，文档的具体内容均在 `docs` 目录中。\n```yaml\n..........\nnav:\n    - 产品介绍: index.md\n    - 快速入门: quick_start.md\n    - 系统架构: system_arch.md\n    - 安装部署:\n        - 在线安装: installation/online_installation.md\n        - 离线安装: installation/offline_installation.md\n        - 在线升级: installation/online_upgrade.md\n        - 离线升级: installation/offline_upgrade.md\n        - 命令行工具: installation/cli.md\n    - 功能手册:\n        - 通用功能: user_manual/general.md\n        - 主页: user_manual/homepage.md\n        - 管理中心:\n            - 云账号: \n                - 添加云账号: user_manual/management/add_cloudaccount.md\n                - 数据同步设置: user_manual/management/sysn_setting.md\n           - 用户与租户: \n                - 用户管理: user_manual/management/user_management.md\n                - 角色管理: user_manual/management/role_management.md\n                - 组织管理: user_manual/management/org_management.md\n            - 日志管理: user_manual/management/log.md\n            - 模块管理: user_manual/management/modoule.md\n            - 系统设置: user_manual/management/system_management.md\n\n        - 云主机管理:\n            - 创建云主机: user_manual/cloud-server/create_server.md\n            - 云主机管理: user_manual/cloud-server/server.md\n            - 磁盘管理: user_manual/cloud-server/disk.md\n            - 任务: user_manual/cloud-server/task.md\n            - 回收站: user_manual/cloud-server/Recycling_station.md\n        - 云账单:\n            - 账单总览: user_manual/finance-management/bill_overview.md\n            - 账单明细: user_manual/finance-management/bill_detail.md\n            - 自定义账单: user_manual/finance-management/custom_bill.md\n            - 分账设置: user_manual/finance-management/ledger_setting.md \n        - 运营分析:\n            - 总览: user_manual/operation-analytics/overview.md\n            - 基础资源分析: user_manual/operation-analytics/infrastructure_analysis.md\n            - 云主机分析: user_manual/operation-analytics/server_analysis.md\n            - 磁盘分析: user_manual/operation-analytics/disk_analysis.md\n            - 资源优化: user_manual/operation-analytics/resource optimization.md\n     \n        - 安全合规:\n            - 总览: user_manual/security-compliance/overview.md\n            - 扫描检查: user_manual/security-compliance/compliance_scan.md\n            - 规则设置: \n                - 合规规则: user_manual/security-compliance/rule_setting.md\n                - 规则组: user_manual/security-compliance/rule_group.md\n            - 风险条例: user_manual/security-compliance/risk.md\n    - 开发文档:\n        - 环境准备: dev_manual/dev_manual_prepare.md\n        - 新增一个扩展模块: dev_manual/dev_manual_new_module.md\n        - 开发指南: dev_manual/dev_manual.md\n    - 更新日志: update_log.md\n    - 联系我们: contact.md\n..........\n```\n\n文档内容使用 markdown 语法编写，若要添加新的文档，需要先在 `mkdocs.yml` 文件中的 `nav` 部分增加对应章节导航。\n\n### 本地调试文档\n\n```bash\nmkdocs serve\n```\n\n执行上述命令后，可通过 `http://127.0.0.1:8000` 地址查看生成的文档内容，当修改文档后，页面内容会自动更新。\n\n### 构建文档\n\n```bash\nmkdocs build\n```\n\n执行上述命令后，会在 `site` 目录下生成文档站点的静态文件，将目录中的内容复制到任意 HTTP 服务器上即可完成文档的部署。\n\n## 帮助完善文档\n\n### Fork 文档仓库\n\n点击仓库右上角的 `fork` 按钮，复制本仓库到自己的 github 账号。\n\n### 克隆 fork 后的仓库\n\n```bash\ngit clone https://github.com/your-github-account/docs.git\n```\n\n### 本地修改并调试\n\n### Push 修改内容到 GitHub 仓库\n\n### 提交 Pull Request 到本仓库\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1panel-dev%2Fcloudexplorer-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F1panel-dev%2Fcloudexplorer-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1panel-dev%2Fcloudexplorer-docs/lists"}