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

How to run the documentation locally? #14628

Closed
danse opened this issue Sep 16, 2014 · 2 comments
Closed

How to run the documentation locally? #14628

danse opened this issue Sep 16, 2014 · 2 comments
Labels

Comments

@danse
Copy link

danse commented Sep 16, 2014

It seems to be obvious, but yet i am not able too see my changes locally. Maybe this issue may lead to a small improvement in the getting started section.

I am working on the current master, 97a3f94075e84e8b085ae0d5e9e52b250ff029d9. What i did is installing the Node dependencies, Jekyll and Ruby, then running:

$ grunt dist
$ grunt jekyll
$ jekyll serve

All commands seem to be successful, but navigating to the served site, i do not see my changes. I also tried jekyll build, it also seems to be successful, but no changes on the served doc. I see that my dist/css/bootstrap.css is different from _gh_pages/dist/css/bootstrap.css, but i would not know how to align them, besides manually copy the files

@hnrch02
Copy link
Collaborator

hnrch02 commented Sep 16, 2014

You need to run grunt docs (or grunt docs-css if you don't want to run the HTML validation) instead of just grunt jekyll. Which getting started section are you referring to?

@danse
Copy link
Author

danse commented Sep 16, 2014

Yeah! Thanks, so the way to go from editing to preview is grunt docs && jekyll serve

danse added a commit to sourcefabric-innovation/bootstrap that referenced this issue Sep 16, 2014
@cvrebert cvrebert added the docs label Sep 16, 2014
@mdo mdo closed this as completed in c5c67d0 Sep 17, 2014
callistino pushed a commit to callistino/bootstrap that referenced this issue Sep 22, 2014
* 'master' of github.com:callistino/bootstrap: (102 commits)
  the justified nav bug is still present in Safari v7.1
  grunt
  Fixes twbs#14592: Add new variable for progress border radius
  grunt
  Fixes twbs#14642: Add docs mention for blank checkboxes and radios
  grunt
  Make it easier to see failing tests in Sauce screencasts
  tweak `grunt docs` description
  fix twbs#14609
  Follow-up to twbs#14581: Use div instead of HTML5 section for IE8
  Fix tooltip misplacement with "auto top"
  Fixes twbs#14628, twbs#14629: Add note to docs about grunt docs command
  grunt
  grunt
  Must explicitly destroy tooltip in SVG unit test since its container
is body.
  modal docs: ensure all <button>s have an explicit `type` attribute
  Update github links in footer.
  README.md: Add npm install info.
  Remove unused Tooltip#validate method
  grunt
  ...

Conflicts:
	dist/css/bootstrap-theme.css.map
	dist/css/bootstrap.css
	dist/css/bootstrap.css.map
	dist/css/bootstrap.min.css
	dist/js/bootstrap.js
	dist/js/bootstrap.min.js
	docs/_includes/components/badges.html
	docs/_includes/components/input-groups.html
	docs/_includes/components/pagination.html
	docs/_includes/js/collapse.html
	docs/assets/js/customize.min.js
	docs/assets/js/raw-files.min.js
	docs/dist/css/bootstrap-theme.css.map
	docs/dist/css/bootstrap.css
	docs/dist/css/bootstrap.css.map
	docs/dist/css/bootstrap.min.css
	docs/dist/js/bootstrap.js
	docs/dist/js/bootstrap.min.js
	less/dropdowns.less
	less/forms.less
	less/jumbotron.less
	less/panels.less
	less/print.less
Saranya-Raaj pushed a commit to Saranya-Raaj/bootstrap that referenced this issue Oct 9, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants