search

i18next / i18next-gitbook

165 stars 172 forks source link

Running documentation preview on local machine #222

Closed marcalexiei closed 7 months ago

marcalexiei commented 7 months ago

Issue like https://github.com/i18next/i18next/issues/2151 might result in adding new content to the documentation.

I'm not very familiar with git-book, so I would like to know if it is possible to run the site on my local machine before opening a PR.

I found that a CLI was available but now is deprecated: https://github.com/GitbookIO/gitbook-cli?tab=readme-ov-file#%EF%B8%8F-deprecation-warning

Recently I tried some static site generator tools to rebuild commitlint documentation (https://commitlint.js.org)

They both allow you to build / preview static site locally but I assume that rebuilding the doc is not an option right now 😅.

adrai commented 7 months ago

I'm not familiar with running the (new) gitbook locally... I'm personally using the gitbook editor directly... or create a PR in the markdown files... For now, we would like to keep the docs as is... so if possible create a PR... we'll review it and fix any issues if necessary