Skip to content

Update Gitbook version #1891

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

Merged
merged 2 commits into from
Sep 4, 2016
Merged

Update Gitbook version #1891

merged 2 commits into from
Sep 4, 2016

Conversation

timdorr
Copy link
Member

@timdorr timdorr commented Aug 10, 2016

Went down this rabbit hole because I was sick of the graceful-fs warnings on Node 6. So, this fixes that.

Retained everything from the original Gitbook theme, as far as I can tell. The only thing missing is the read-tracking checkmarks, but honestly I didn't find much value in them. Maybe others do, though? I can look into a replacement if it's a big deal.

Also, I'm going to go check into #1865 so the next build works for hash links.

@timdorr
Copy link
Member Author

timdorr commented Aug 10, 2016

OK, that was simple. It's a little bit wonky, but it works and now also provides a nice Github-style hover link for each heading in the document. Makes finding those anchors even easier.

@markerikson
Copy link
Contributor

FYI, when I wrote the FAQ, I manually inserted anchor tags into the Markdown contents to give shorter hash links, since the auto-generated links for each heading are slugified version of the entire heading text (and those read horribly). The TOC at the top of the FAQ then links to to those short-hash-tag anchors.

@timdorr
Copy link
Member Author

timdorr commented Aug 10, 2016

This plugin retains any manually-added anchors, so they all still work just fine in my local build.

@timdorr
Copy link
Member Author

timdorr commented Aug 12, 2016

Highly scientific Twitter poll: https://twitter.com/timdorr/status/763918833987923969

@timdorr timdorr merged commit 2280fec into master Sep 4, 2016
@timdorr timdorr deleted the booking-it branch September 4, 2016 17:19
@timdorr
Copy link
Member Author

timdorr commented Sep 4, 2016

Updated and republished!

@markerikson
Copy link
Contributor

Hey, @timdorr . I'm having trouble getting the docs to build properly atm, even off master. It's only finding the README, none of the rest of the pages. Tried clearing out _books a couple times, with no luck. Currently pulling down a fresh clone of the repo to see what happens.

Any ideas?

@timdorr
Copy link
Member Author

timdorr commented Sep 25, 2016

Does npm run docs:prepare run cleanly? Are there any errors in the output? SUMMARY.md in the root should be a symlink to docs/README.md.

@markerikson
Copy link
Contributor

Seems to run cleanly, no errors. Output:

info: 11 plugins are installed
info: 10 explicitly listed
info: loading plugin "edit-link"... OK
info: loading plugin "prism"... OK
info: loading plugin "github"... OK
info: loading plugin "anchorjs"... OK
info: loading plugin "livereload"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 274 asset files
info: >> generation finished with success in 1.2s !

When you say "symlink", do you mean actual symlink, like filesystem-level? What I've got for SUMMARY.md is a text file with the content docs/README.md.

The generated HTML currently has the main README content in the right pane, and the TOC in the left pane only has "1.1 Introduction" listed.

Did the recent changes add some *nix-only config so that it can't be built on Windows any more?

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

Successfully merging this pull request may close these issues.

None yet

2 participants