-
Notifications
You must be signed in to change notification settings - Fork 6
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
MkDocs build is slow #1397
Comments
StevenMaude
changed the title
MkDocs build is slow when editing files
MkDocs build is slow
Nov 29, 2023
Specifically, what you'll have to do in
and avoid accidentally committing/pushing these changes. Little bit irritating. But this cuts the rebuild time on edit back down from 10-15 seconds to 2 seconds for me, while editing the main documentation. |
StevenMaude
added a commit
that referenced
this issue
Aug 22, 2024
For editing the site using a dev container locally, or in Codespaces online. The `deadsnakes` configuration is taken from the `research-template-docker` repository: https://github.com/opensafely-core/research-template-docker/blob/669a76d79c198925d788dedc34fe3c5a831872b5/Dockerfile#L20-L21 which avoids installing `software-properties-common` first (to get the `add-apt-repository` command. The dev container settings are based on the Bennett site configuration, with a longer autosave delay, because the site currently takes a while to build (#1397). Arguably, the save delay could be longer still. No Markdown plugins are installed yet; maybe that's something we could do in future.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This doesn't matter too much for an actual build during deployment, but is inconvenient for local editing.
This is primarily due to the use of the multirepo plugin. It takes over 10 seconds on my computer, which is a little bit slow when you're editing and wanting quick feedback on appearance. It used to take something like 1-2 seconds.
It apparently wants to clone the project every time you edit files; upstream issue: jdoiro3/mkdocs-multirepo-plugin#129.
Other non-ideal workarounds for local editing:
#1317 might help here.
The text was updated successfully, but these errors were encountered: