The API ONLYOFFICE site is the place for documentation on how to use ONLYOFFICE.
The documentation content is formatted in markdown and can be found in the site directory. Easiest way to make edits is to navigate to the markdown file to be updated, and click the Edit button in the top right (the pencil icon). After making the edit, submitting the changes will create a Pull Request (PR) for reviewed. Please feel free to ask any questions within the our forum, we're happy to help.
To build the site from the source, ensure you're using the most recent versions of Node and Npm, and pull the latest from master. Next, run npm install
, npm run build
to build the docs files and npm start
to launch the site in development mode.
To generate OpenAPI docs for docspace backend, you need to prepare a single file:
cd openapi/docspace
npm i
npx openapi-merge-cli
To generate all OpenAPI docs, run the following command from the root directory of your project:
yarn docusaurus gen-api-docs all
This will generate API docs for all of the OpenAPI specification (OAS) files referenced in your
docusaurus-plugin-openapi-docs
config.
You may also generate OpenAPI docs for a single path or OAS by specifying the unique id
:
yarn docusaurus gen-api-docs <id>
Example:
yarn docusaurus gen-api-docs docspaceBackend
The example above will only generate API docs relative to
docspaceBackend
.
To clean/remove all API Docs, run the following command from the root directory of your project:
yarn docusaurus clean-api-docs all
You may also remove a particular set of API docs by specifying the unique id
of your desired spec instance.
yarn docusaurus clean-api-docs <id>
Example:
yarn docusaurus clean-api-docs docspaceBackend
The example above will remove all API docs relative to
docspaceBackend
.