diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 1ff5ee5..55ba34c 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -17,5 +17,7 @@ jobs: - uses: actions/checkout@v3 - uses: DavidAnson/markdownlint-cli2-action@v9 with: - globs: '*.md,develop/*.md,scripts/**.md' - separator: ',' \ No newline at end of file + globs: | + .markdownlint.jsonc + '*.md,develop/*.md,scripts/**.md' + separator: ',' diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc new file mode 100644 index 0000000..77266c0 --- /dev/null +++ b/.markdownlint.jsonc @@ -0,0 +1,5 @@ +{ + "line-length": { + "code_block_line_length": 300 + } +} \ No newline at end of file diff --git a/develop/README.md b/develop/README.md index dffd766..c75b597 100644 --- a/develop/README.md +++ b/develop/README.md @@ -74,46 +74,16 @@ The folders `server` is optional **Note**: server start with `sdkjs` and `web-apps` takes 10 minutes and takes 15 minutes with `server` -### Windows (cmd) - run with `sdkjs` and `web-apps` ```bash -docker run -i -t -p 80:80 --restart=always ^ - -v %cd%/sdkjs:/var/www/onlyoffice/documentserver/sdkjs ^ - -v %cd%/web-apps:/var/www/onlyoffice/documentserver/web-apps ^ - documentserver-develop +docker run -i -t -p 80:80 --restart=always -v %cd%/sdkjs:/var/www/onlyoffice/documentserver/sdkjs -v %cd%/web-apps:/var/www/onlyoffice/documentserver/web-apps documentserver-develop ``` run with `sdkjs`, `web-apps` and `server` ```bash -docker run -i -t -p 80:80 --restart=always ^ - -v %cd%/sdkjs:/var/www/onlyoffice/documentserver/sdkjs ^ - -v %cd%/web-apps:/var/www/onlyoffice/documentserver/web-apps ^ - -v %cd%/server:/var/www/onlyoffice/documentserver/server ^ - documentserver-develop -``` - -### Linux or macOS (bash) - -run with `sdkjs` and `web-apps` - -```bash -docker run -i -t -p 80:80 --restart=always \ - -v $(pwd)/sdkjs:/var/www/onlyoffice/documentserver/sdkjs \ - -v $(pwd)/web-apps:/var/www/onlyoffice/documentserver/web-apps \ - documentserver-develop -``` - -run with `sdkjs`, `web-apps` and `server` - -```bash -docker run -i -t -p 80:80 --restart=always \ - -v $(pwd)/sdkjs:/var/www/onlyoffice/documentserver/sdkjs \ - -v $(pwd)/web-apps:/var/www/onlyoffice/documentserver/web-apps \ - -v $(pwd)/server:/var/www/onlyoffice/documentserver/server \ - documentserver-develop +docker run -i -t -p 80:80 --restart=always -v %cd%/sdkjs:/var/www/onlyoffice/documentserver/sdkjs -v %cd%/web-apps:/var/www/onlyoffice/documentserver/web-apps -v %cd%/server:/var/www/onlyoffice/documentserver/server documentserver-develop ``` ### Open editor @@ -130,22 +100,10 @@ To change something in `sdkjs` do the following steps 1)Edit source file. Let's insert an image url into each open document. Do the following command. -Windows(cmd) - ```bash -sed -i "s,this.sendEvent('asc_onDocumentContentReady');,^ -this.sendEvent('asc_onDocumentContentReady');\n^ -this.AddImageUrl(['http://localhost/example/images/logo.png']);," ^ -sdkjs\common\apiBase.js +sed -i "s,this.sendEvent('asc_onDocumentContentReady');,this.sendEvent('asc_onDocumentContentReady');\nthis.AddImageUrl(['http://localhost/example/images/logo.png']);," sdkjs\common\apiBase.js ``` -Linux or macOS (bash) - -sed -i "s,this.sendEvent('asc_onDocumentContentReady');, -this.sendEvent('asc_onDocumentContentReady');\n -this.AddImageUrl(['http://localhost/example/images/logo.png']);," - sdkjs\common\apiBase.js - 2)Delete browser cache or hard reload the page `Ctrl + Shift + R` 3)Open new file in browser @@ -155,11 +113,9 @@ To change something in `server` do the following steps 1)Edit source file. Let's send `"Hello World!"` chart message every time a document is opened.Do the following command -sed -i 's#opt_hasForgotten, opt_openedAt) {# -opt_hasForgotten, opt_openedAt) {\n -yield* onMessage(ctx, conn, {"message": "Hello World!"});#' - server\DocService\sources\DocsCoServer.js -= +```bash +sed -i 's#opt_hasForgotten, opt_openedAt) {#opt_hasForgotten, opt_openedAt) {\nyield* onMessage(ctx, conn, {"message": "Hello World!"});#' server\DocService\sources\DocsCoServer.js +``` 2)Restart document server process