0.1.0 • Published 6 months ago
@aigne/publish-docs v0.1.0
@aigne/publish-docs
Usage
import { publishDocs } from "@aigne/publish-docs";
await publishDocs({
sidebarPath: "./docs/_sidebar.md", // Path to your docsify sidebar file
boardId: "xxx",
appUrl: "https://xxx",
// Other parameters are optional
});Note: The
sidebarPathshould point to a file in docsify sidebar format.
Parameters
sidebarPath: string (required) - Path to the docsify sidebar file.boardId: string (optional)appUrl: string (optional)accessToken: string (optional, takes precedence over OAuth)scope: string (optional, required ifaccessTokenis not provided)clientId: string (optional, required ifaccessTokenis not provided)clientSecret: string (optional, required ifaccessTokenis not provided)redirectUri: string (optional, required ifaccessTokenis not provided)
If a parameter is not provided, it will be read from the corresponding environment variable if available.
accessTokentakes precedence over OAuth parameters.
0.1.0
6 months ago