Strona główna Odkrywaj Pomoc
Zaloguj się
wiki
/
weseek__growi
kopia lustrzana https://github.com/weseek/growi
2
0
Forkuj 0
Pliki Problemy 0 Wiki
Drzewo: a3d23e7cda
Gałęzie Tagi
weseek__growi
/
apps
/
pdf-converter
Futa Arai a3d23e7cda add docker-compose section in pdf-converter docker README 1 rok temu
..
docker a3d23e7cda add docker-compose section in pdf-converter docker README 1 rok temu
src 6787c1f4f8 fix tsed logger error in pdf converter 1 rok temu
.env e1f8e1fe82 add pdf-converter app 1 rok temu
.eslintignore abab458ad1 remove client library file from pdf-converter 1 rok temu
.eslintrc.cjs f05ae1dac1 rename .eslintrc.js to .eslintrc.cjs 1 rok temu
.gitignore dadcf071c5 gitignore spec dir for pdf-converter 1 rok temu
README.md 85a9b4298e add documentation for pdf-converter-client 1 rok temu
README_JP.md 85a9b4298e add documentation for pdf-converter-client 1 rok temu
nodemon.json 87dae53901 change pdf-converter package type to module 1 rok temu
package.json ea519deb43 Merge branch 'feat/135772-pdf-page-bulk-export' into feat/155548-157823-pdf-converter-release-ci 1 rok temu
tsconfig.build.json b07fc9d278 add ci-slackbot-proxy-launch-prod job 1 rok temu
tsconfig.json 87dae53901 change pdf-converter package type to module 1 rok temu
turbo.json f14de7137d add settings for pdf-converter release 1 rok temu

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. Open command palette (Windows: Ctrl + Shift + P, Mac: Cmd + Shift + P)
  3. Choose Dev Containers: Open folder in Container...
  4. Choose the root growi directory you have cloned from https://github.com/weseek/growi
    • Not the PDF-Converter directory (growi/apps/pdf-converter)
  5. Choose GROWI-PDF-Converter as the container to open
  6. Execute cd apps/pdf-converter && turbo dev:pdf-converter to start the pdf-converter app
  7. 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. Open a new VSCode window and open PDF-Converter devcontainer
  3. Start both apps
  4. Request PDF bulk export from the page menu in the GROWI app
    • It might take a few minutes, depending on GROWI's configurations

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