hotlong / steedos-docs

FineBuild docs for developer and administrator.

Website

This is the source of documentation for Steedos Platform, hosted at docs.steedos.com, powered by Docusaurus v2.

Installation

yarn

Local Development

yarn start

Run zh-CN version

yarn start:cn

Write translations for z-CN

yarn write-translations:cn

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build
yarn build:openapi

This command generates static content into the build directory and can be served using any static contents hosting service.

Deploy to Github

export GIT_USER=hotlong
export GIT_PASS=
export DEPLOYMENT_BRANCH=master
yarn deploy

Generate PDF

use docs-to-pdf

Developer Documentation

npx docs-to-pdf --initialDocURLs="https://docs.steedos.cn/zh-CN/developer/"  --contentSelector="article"  --paginationSelector="a.pagination-nav__link.pagination-nav__link--next" --outputPDFFilename="build/steedos-developer-zh-CN.pdf" --excludeSelectors=".breadcrumbs,section.row,.theme-doc-footer" --pdfMargin="80,60,80,60" --coverTitle="Steedos Developer Documentaion"  --baseUrl="https://docs.steedos.cn/zh-CN/developer/"  --excludePaths="/zh-CN/developer/api/openapi"

Platform Documentation

npx docs-to-pdf --initialDocURLs="https://docs.steedos.cn/zh-CN/"  --contentSelector="article"  --paginationSelector="a.pagination-nav__link.pagination-nav__link--next" --baseUrl="https://docs.steedos.cn/zh-CN/" --outputPDFFilename	'build/steedos-platform-zh-CN.pdf'  --excludeSelectors=".breadcrumbs,section.row,.theme-doc-footer" --pdfMargin="80,60,80,60" --coverTitle="Steedos Platform Documentaion"   --excludePaths="/zh-CN/getting-started,/zh-CN/user,/zh-CN/deploy"