-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Replies: 1 comment · 5 replies
-
I've been using JtD to document our company's internal wiki of event definitions. We have thousands of events and properties defined, and I use a script to automatically generate hundreds of MD documents, which results in something similar to Java code reference. (currently - 1200 MD files) The MD documents involve plenty of hierarchy, internal links and search hints, and it used to take ~90 seconds for JtD to generate them, which could be a bit of a pain when trying to adjust the document templates. Since this recent release, JtD build dropped to ~45 seconds, which was a significant productivity boost. Thank you guys! |
Beta Was this translation helpful? Give feedback.
All reactions
-
Glad to hear it! @pdmosses definitely deserves some kudos for the scale of the optimization work that he's done - JtD wouldn't be the same without him 😊 |
Beta Was this translation helpful? Give feedback.
All reactions
-
@ofirz Thanks for letting us know that your build time dropped so much with v0.8.0. I guess your site and repo are private – otherwise it would be helpful for us to profile building it with various versions of JtD, to supplement the current profiling results. Anyway, if you run |
Beta Was this translation helpful? Give feedback.
All reactions
-
I'm sorry I am not allowed to share proprietary data outside. I might be able to instrument the profiling results with some help. Meanwhile, running --profile locally, I get these results - not sure about their actual meaning.
p.s. this is a partial build, and I realize my file count included the contents of the _site folder, hence the actual site size is roughly 600 pages. |
Beta Was this translation helpful? Give feedback.
All reactions
-
Good, thanks!
There should have also been a line at the bottom stating "done in … seconds". (That is just the render time – the total build time can be significantly higher.)
Jekyll usually converts all MD files that have front matter to HTML, and doesn't copy their MD to _site. To exclude files that don't have front matter from _site:
My (possibly mistaken) interpretation of the profile results is that Jekyll has rendered 442 MD files to HTML in about 20 seconds. The rest of the build time might have been taken by copying all the other files. Your profile results indicate that no time was used to render auto-generated TOCs at the bottom of parent pages. Do your MD pages with children generally set Based on the formatting of the profiling results, it appears that the site is currently built with Jekyll 3. Changing the Two potential complications with switching to Jekyll 4:
|
Beta Was this translation helpful? Give feedback.
All reactions
-
First - thank you @pdmosses for the detailed review. I didn't mean to make an inquiry, only to congratulate you on such a great piece of software. Apologies for dropping the most important line:
In order to make sure I'm not dreaming, I reverted to JtD 0.6.0 an rebuilt, getting a significantly longer build time. The majority of the improvements happened in 0.7.0, with some more seconds shaved off in 0.8.0. Below are the 0.6.0 results:
I was wrong about the # of pages; the entire site has ~600 MD files, but this auto-generated part only has 442 files. There are no TOCs on these particular pages. You are also right to assume I'm using Jekyll 3.9.2, which I picked as a default for GitHub. When I get more time to dive into this I will consider switching to Jekyll 4.x, but at this time I feel no urgency to do so. Thank you for all the tips, and for the ongoing improvements to JtD. I'm about to embark on another JtD-based reference wiki for my org soon, as the visual presentation and site functionality are simply superb. |
Beta Was this translation helpful? Give feedback.
-
Release v0.8.0
Hi folks! This first minor release of 2024 has a short number of changes: a large improvement of build times for large sites, a new keyboard shortcut to focus the search bar, and sidebar navigation bugfixes for "pretty" URLs (with
.html
omitted) and the clickable area on Safari. This release has no explicit breaking changes and should be a straightforward upgrade for most (if not all) users.Using Release
v0.8.0
Users who have not pinned the theme version will be automatically upgraded to
v0.8.0
the next time they build their site.To use this release explicitly as a remote theme:
To use this version explicitly as a gem-based theme, pin the version in your
Gemfile
and re-runbundle install
orbundle update just-the-docs
:To use and pin a previous version of the theme, replace the
0.8.0
with the desired release tag.New Features
Bugfixes
.html
omitted from URL by [@pdmosses] in [Fix navigation when.html
omitted #1374]Documentation
New Contributors
This discussion was created from the release v0.8.0.
Beta Was this translation helpful? Give feedback.
All reactions