Почетна Преглед Помоћ
Пријавите се
wiki
/
weseek__growi
огледало од https://github.com/weseek/growi
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: 5256df65cf
Гране Ознаке
weseek__growi
/
apps
/
pdf-converter
GitHub Action 5256df65cf Bump version пре 1 година
..
docker efcc48a4ca fix dir permission override пре 1 година
src 4b41469da1 fix tsed logger injection пре 1 година
.env e1f8e1fe82 add pdf-converter app пре 1 година
.eslintignore abab458ad1 remove client library file from pdf-converter пре 1 година
.eslintrc.cjs f05ae1dac1 rename .eslintrc.js to .eslintrc.cjs пре 1 година
.gitignore dadcf071c5 gitignore spec dir for pdf-converter пре 1 година
README.md ef3a22ca32 change BULK_EXPORT_PDF_CONVERTER_URI configuration file to .env.development.local пре 1 година
README_JP.md ef3a22ca32 change BULK_EXPORT_PDF_CONVERTER_URI configuration file to .env.development.local пре 1 година
nodemon.json 87dae53901 change pdf-converter package type to module пре 1 година
package.json 5256df65cf Bump version пре 1 година
tsconfig.build.json b07fc9d278 add ci-slackbot-proxy-launch-prod job пре 1 година
tsconfig.json 87dae53901 change pdf-converter package type to module пре 1 година
turbo.json f14de7137d add settings for pdf-converter release пре 1 година

README.md

日本語 🇯🇵

About this app

GROWI provides a feature that bulk exports pages in PDF format, which can be executed from the page menu. This app (PDF-Converter) is necessary to convert markdown pages to PDF during that process.

Development

Spec (only in Japanese)

/資料/内部仕様/Page Bulk Export/PDF エクスポート

Developing inside a devcontainer

  1. Open VSCode
  2. Create .devcontainer/compose.extend.yml with the same contents as .devcontainer/compose.extend.template.yml
  3. Open command palette (Windows: Ctrl + Shift + P, Mac: Cmd + Shift + P)
  4. Choose Dev Containers: Open folder in Container...
  5. Choose the root growi directory you have cloned from https://github.com/weseek/growi
    • Not the PDF-Converter directory (growi/apps/pdf-converter)
  6. Choose GROWI-PDF-Converter as the container to open
  7. Execute cd apps/pdf-converter && turbo dev:pdf-converter to start the pdf-converter app
  8. Edit files in apps/pdf-converter for development

Requesting PDF-Converter from GROWI (both running in a devcontainer)

  1. Open VSCode and open GROWI devcontainer
    • Choose GROWI-Dev for the container to open
  2. Add BULK_EXPORT_PDF_CONVERTER_URI=http://pdf-converter:3010 to apps/app/.env.development.local
  3. Open a new VSCode window and open PDF-Converter devcontainer
  4. Start both apps
  5. Request PDF bulk export from the page menu in the GROWI app
    • It might take a few minutes, depending on GROWI's configurations

Note

When creating both containers from scratch or rebuilding them, make sure to select and create GROWI-Dev first. This is necessary because GROWI-Dev uses devcontainer features for enabling node, and features is only enabled for the first container created.

PDF-Converter client library

pdf-converter-client is a client library for requesting PDF-Converter, and is used by GROWI internally. It's code is auto-generated from the PDF-Converter code.

When you update the PDF-Converter API, you should also always update the client library.

You can update the client library by one of the following ways:

  • Execute cd ${growi_root_path}/packages/pdf-converter-client && pnpm gen:client-code
  • Start GROWI app
    • Inside GROWI devcontainer (not PDF-Converter devcontainer), execute cd ${growi_root_path}/apps/app && turbo dev