Skip to content
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.

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

Add more documentation around running docs locally #5718

Closed
wuweiweiwu opened this issue Sep 5, 2018 · 2 comments · Fixed by #5724
Closed

Add more documentation around running docs locally #5718

wuweiweiwu opened this issue Sep 5, 2018 · 2 comments · Fixed by #5724

Comments

@wuweiweiwu
Copy link
Contributor

Expected Behavior

Should be able to get local environment for gitbook docs to work through CONTRIBUTING.md

Current Behavior

Local dev is hard since there is only gulp docs to build the static site and if you want a local dev server, you have to install gitbook cli and a bunch of commands

Possible Solution

Add more docs to contributing about how to run docs locally. Add gitbook serve to gulp or npm tasks

@simonbrunel
Copy link
Member

We could simply add support for the --watch argument as it's done in the datalabels plugin and reference this command in the contribution guide.

gulp docs --watch

@etimberg
Copy link
Member

etimberg commented Sep 5, 2018

I like the idea of a --watch flag

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants