Skip to content

feat: add local development support #2445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
nijoe1 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: add local development support #2445

nijoe1 wants to merge 4 commits into from
+1,275 −4

Conversation

@nijoe1
Copy link
Contributor

@nijoe1 nijoe1 commented Dec 1, 2025 •
edited
Loading

Summary

  • Implements a custom CLI wrapper for local GitBook development using legacy Node.js v10
  • Adds automated nvm-based environment setup for building and previewing docs locally
  • Includes custom GitBook plugins for tabs, hints, and embed components compatibility

Closes #2444

How to test

  • Run npm run setup to install dependencies and configure environment
  • Run npm run dev to verify live reload development server on port 4003
  • Run npm run build to verify static site generation to _book/

nijoe1 added 3 commits December 1, 2025 16:55
@nijoe1
feat: implements local development workflow with custom gitbook-cli w…
84a0011 
…rapper

- Replaces legacy gitbook-cli with a custom local wrapper
- Automatically manages Node v10 via nvm for GitBook compatibility
- Adds live reload/watch mode
@nijoe1
chore: fixes incompatible gitbook-cli tuple text format
8d8848a
@nijoe1
fix: lint checker error
3495ec0
@longfeiWan9
Copy link
Member

longfeiWan9 commented Dec 4, 2025

I am trying to build and test docs locally using this PR, but I ran into an incompatibility with TypeScript and Node.js.

  • Gitbook-cli requires Node.js v10.x, but github-plugins is using certain Typescript Syntax which was introduced after Node 14, so it fails.
  • It means I need to downgrade node from 24 to 10, and downgrade typescript from 5.9.3 to 3.9.
    • Those very old versions of Node and Typescript are not suitable for other apps I am running on my computer.
    • It is a bit annoying for contributors who want to run Filecoin docs locally.
    • It also introduces more compatibility issues in this codebase.

@nijoe1, overall, this does not work on my local.

@nijoe1
Copy link
Contributor Author

nijoe1 commented Dec 4, 2025

Even after running npm run setup ? @longfeiWan9

In this script I am downgrading the version only for the current session...

@nijoe1
refactor(cli): simplify and consolidate CLI codebase
f6ecc61 
- Remove dead code (ServerManager, spawnWithNodeVersion, cancel methods)
- Consolidate constants and utilities to single sources
- Add --verbose flag support across all commands
- Use local gitbook-cli install in .gitbook/cli/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

enable local development for Filecoin docs

2 participants

@nijoe1 @longfeiWan9