Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/growingio/growingio-sdk-docs
GrowingIO sdk v4 document
https://github.com/growingio/growingio-sdk-docs
Last synced: 2 months ago
JSON representation
GrowingIO sdk v4 document
- Host: GitHub
- URL: https://github.com/growingio/growingio-sdk-docs
- Owner: growingio
- Created: 2021-07-13T07:50:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T10:08:12.000Z (2 months ago)
- Last Synced: 2024-10-29T12:11:52.294Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 243 MB
- Stars: 4
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 站点地址
[SDK 4.0技术文档-https://growingio.github.io/growingio-sdk-docs/](https://growingio.github.io/growingio-sdk-docs/)
若想要修改文档请 clone 本项目到本地修改。 文档位于 docs 目录下，博客文章位于 blog 目录下。
具体的写作教程请参考 [docusaurus](https://www.docusaurus.cn/docs/)
## 关于部署
目前将文档部署在 [Github Pages](https://growingio.github.io/growingio-sdk-docs/) 上，占用的为 `gh-pages` 分支，目前该分支已设置保护，除去 Github CI 可以访问外其他人无法修改。
## 关于发版
所有人只能对 master 分支提交 pr 操作，ci会自动检查是否存在错误。
合并分支后，ci 会自动将站点部署到 [Github Pages](https://growingio.github.io/growingio-sdk-docs/) 上。
## 关于本地
clone 本站点后，若想在本地运行，请确保本地有以下环境：
1. Node.js >= 18.0.0 或更高版本（可以通过运行 node -v 命令检查版本）。你可以使用 nvm 在一个计算机上管理多个版本的 Node.
进入到站点目录，运行
```nodejs
npm install //安装依赖软件包
npm run build //检查构建是否成功
npm run start //启动开发服务器
```
默认情况下，浏览器将打开 地址。
## 关于 version 脚本
使用 `github_version_fetch.py` 脚本可以从 github 仓库自动更新版本记录，省掉人工复制的麻烦。
使用方法：(只需要 python3 的环境即可，无依赖)
```shell
cd <项目地址>
python github_version_fetch.py
```
该脚本会更新各个平台下的 `version.md` 文件。
配置文件为 `version_config.json`,其中enable字段表示是否启用。
## 项目结构概要
`/blog/` - 包含博客的 Markdown 文件。如果你不想或不需要博客，则可以将此目录删除。在 博客指南 文档中可以找到更多详细信息
`/docs/` - 包含文档的 Markdown 文件。可在 sidebars.js 中自定义文档侧边栏的顺序。在 文档指南 中可以找到更多详细信息
`/src/` - 非文档文件，例如页面（pages）或自定义的 React 组件。你不必严格地将非文档文件放到这里，但是将它们集中在此目录下可以更轻松地进行管理，以便您需要进行某些格式校验或处理
`/src/pages` - 此目录中的所有文件都将转换为网站页面(page)。 可以在 页面（pages）指南 中找到更多详细信息
`/static/` - 静态文件目录。此处的所有内容都将复制到最终的 build 目录下
`/docusaurus.config.js` - 包含站点配置的配置文件
`/package.json` - Docusaurus 网站也是一个 React 应用程序。你可以在其中安装和使用所需的任何 npm 软件包
`/sidebar.js` - 生成文档时使用此文件来指定侧边栏中的文档顺序
### 文件夹文档
若是希望点击文件分级目录上也有文档，可以直接在该文件夹新建 `index.md` 文件，slug 设置成文件夹名称，如下所示：
```txt
---
slug: /other
title: 第三方 SDK
---
```
下面为创建文件分级下目录的代码。
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
```
### 新建导航模块
找到 `docusaurus.config.js`，以添加数据指南为例，进行下列操作
1. 在 `plugins` 节点，添加一个新的doc节点，其名为 `knowledge`，并且新建 `sidebarsknowledge.js` 使其为文章自动生成目录；
2. 在 `themeConfig->navbar->items`，添加新的导航 **{to: '/knowledge', label: '数据指南', position: 'left'},**
3. 新建 `knowledge` 文件夹，并新建一个 `slug: /` 的文档，保证点击能链接到正确的文档地址。