Support prerendering of code blocks. #1627
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I marked this as experimental for now. |
mortenpi
reviewed
Jul 8, 2021
There was a problem hiding this comment.
LGTM, other than the one thing.
This file is getting way too complicated though. I was wondering if the pre-rendering could be somehow more self-contained in a separate file.. but I don't actually see how. In any case, I think we need to properly refactor this at some stage.
mortenpi
reviewed
Jul 8, 2021
fredrikekre
force-pushed
the
fe/prerender
branch
3 times, most recently
from
4c8cf01
to
b0146f7
Compare
mortenpi
approved these changes
Jul 8, 2021
Passing `prerender=true` to `Documenter.HTML` now renders syntax
highlighting of code blocks when building the page rather than
in the browser when the page is loaded. This requires a `node`
(NodeJS) executable in PATH or that a path to an executable is
passed as the `node` keyword argument. The `highlightjs` keyword
argument can be used to give a (local) file path to a custrom
hightlight.js library.
Example configuration:
using Documenter, NodeJS_16_jll
makedocs(;
format = Documenter.HTML(
prerender = true, # enable prerendering
node = NodeJS_16_jll.node(), # specify node executable (required if not available in PATH)
# ...
)
# ...
)
This feature is marked as experimental for now.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.