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

Docs improvements: Build-time Syntax highlighting, scroll perf improvements, docs dev/deployment fixes #38

Merged
merged 9 commits into from
Dec 5, 2018

Conversation

lazd
Copy link
Member

@lazd lazd commented Dec 5, 2018

Description

  • Does build-time syntax highlighting with Prism instead of at run-time with Rainbow
  • Removes the pushState on scroll
  • Removes some dead code
  • Removes an unused normalize.css
  • Fixes livereload when working on docs resources
  • Fixes gh-pages generation

This 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

  • Docs fix (doesn't affect distributed package)

@lazd lazd added documentation Because documentation is important and shouldn't be broken performance labels Dec 5, 2018
@lazd lazd requested review from filmaj and GarthDB December 5, 2018 21:37
@lazd lazd changed the title Docs improvements: Build-time Syntax highlighting, scroll perf improvements Docs improvements: Build-time Syntax highlighting, scroll perf improvements, docs dev/deployment fixes Dec 5, 2018
@lazd
Copy link
Member Author

lazd commented Dec 5, 2018

Discussed with @benjamind and @GarthDB and this is ready to merge.

@lazd lazd merged commit 0312550 into master Dec 5, 2018
Copy link
Contributor

@filmaj filmaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved

@GarthDB GarthDB deleted the docsupdates branch September 21, 2020 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Because documentation is important and shouldn't be broken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants