Docs improvements: Build-time Syntax highlighting, scroll perf improvements, docs dev/deployment fixes #38
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
pushState
on scrollThis is not a complete solution to the problems described in the issues below. This change offers only marginal improvements to load time and scroll speed, but they took me a handful of minutes, so we've got that going for us.
Related Issue
#7 - Docs load slow
#6 - Slow scrolling in docs
#26 - Remove
pushState
on scroll#37 - Livereload broken for docs resources
#39 - gh-pages redirects missing
Motivation and Context
This speeds up the loading of the page, and makes scrolling a little bit smoother. It also fixes a couple issues with docs generation that were introduced recently.
How Has This Been Tested?
A bit of inspection in dev tools reveals marginal improvements in scroll jerkiness, and time to initial display has been improved by around 15% (6 seconds to 5 seconds), with time to complete load (including syntax highlighted code samples) improved by 50% (from 10 seconds to 5 seconds).
Types of changes