Generate Table of Contents for each chapter

[mikegeyser]

This generates a table of contents from the output of the html generation, with links to individual sections. It is currently completely unstyled, so that we can use the work already done as a part of #199.

The code below is based on #222, so at present it looks a lot larger than it is, and that PR needs to be merged first. (I've kept them separate, so that they're easier to review - I hope that's ok.)

Please let me know what you think, and I'll make whatever changes are necessary.

[rviscomi]

Getting this error when running locally:

 Generating chapter: en, 2019, performance
(node:9069) UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'children' of undefined
    at nest_headings (/Users/rviscomi/git/google/almanac.httparchive.org/src/tools/generate/generate_table_of_contents.js:61:37)
    at nest_headings (/Users/rviscomi/git/google/almanac.httparchive.org/src/tools/generate/generate_table_of_contents.js:60:39)
    at generate_table_of_contents (/Users/rviscomi/git/google/almanac.httparchive.org/src/tools/generate/generate_table_of_contents.js:9:27)
    at parse_file (/Users/rviscomi/git/google/almanac.httparchive.org/src/tools/generate/generate_chapters.js:28:15)
    at generate_chapters (/Users/rviscomi/git/google/almanac.httparchive.org/src/tools/generate/generate_chapters.js:18:45)
    at <anonymous>
(node:9069) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 3)
(node:9069) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

[mikegeyser]

I've spotted the error, going to need to rework something.

[tyohan]

I got some error on generating chapters locally

Traceback (most recent call last):
  File "generate_chapters.py", line 70, in <module>
    generate_chapters()
  File "generate_chapters.py", line 24, in generate_chapters
    write_template(language, year, chapter, metadata, body)
  File "generate_chapters.py", line 58, in write_template
    file_to_write.write(template.format(body=body, metadata=metadata))
ValueError: expected ':' after conversion specifier```

[tyohan]

@mikegeyser i saw you're generated the toc on the client side with JS. I've done this with mistune so the chapter templates will have toc in generated templates. Also, trying to make sure the CSS styles will shared with methodology pages.

This is how Javascript chapter looks like in chapter-page branch

And in mobile

Sorry i reused your avatar @rviscomi for Addy :D, need to see how the page looks like.

I can finish this chapter page by today so we can see how the chapter pages can be generated config file and markdown contents. So no need for extra json or other files. WDYT @rviscomi

[mikegeyser]

@tyohan The table of contents is being statically generated, not on the client side.

I agree regarding the CSS, I deliberately haven't added styling to this because of the other work that you were doing. :)

[rviscomi]

Sorry we have two very similar PRs doing similar things so there's some confusion. Let's try to divide the work up:

@tyohan focus on styling the Chapter page. For now you can create a static "lorem ipsum" table of contents for styling.

@mikegeyser continue working on the showdown migration and TOC generation.

Does that work for everyone?

[tyohan]

@rviscomi @mikegeyser looks good for me. Will continue to work on on styling

[rviscomi]

@mikegeyser are these changes working and ready for review?

[mikegeyser]

@rviscomi I believe it's working, will rebase off of master and test again. The only outstanding change is to move the html generation into a template, which I will also do now.

[mikegeyser]

Sorry for the churn, I believe that this is ready to go now. I have some more that I want to add (formatting and linting, to pick up errors more easily) but I'll do it in a separate PR.

[tyohan]

I've test this one with my current styling from #251 but need to tune a bit and work perfectly. Good one!

[rviscomi]

@mikegeyser I've merged #251 which created a merge conflict in chapter.html. I was going to try to resolve it but I'll leave that to you since it depends on how you want to implement the TOC markup.

[mikegeyser]

@rviscomi @tyohan I've merged master into this PR and resolved the conflict. It looks right to me, but could you take a look and see if it's right?

The Author information and the Previous/Next isn't implemented yet, should that happen in this PR or can it be in a follow up? (It's not strictly speaking related to this.)

Sorry, I just read this update from @tyohan. Please belay the last, it's been a long day... :P

[rviscomi]

LGTM! 👍