kamilkrzyskow
commented
1 year ago Debugging the 1st issue I've found this:
The assets from the overrides are only added to the initial build. This triggered a memory of the same thing I fixed in the patch to the refactor, so I dig further:
You did merge my fix, but later decided to remove it in https://github.com/ultrabug/mkdocs-static-i18n/commit/c2215b2b400e6a06dc89b6581ede2db04554dbbe or perhaps it's a mistake missed because of the amount of changes.
With the fix restored, no warnings appear related to those files, and they are correctly resolved in the webpage. I don't understand the rationale of limiting the assets to only the first run. Perhaps performance to not copy the files multiple times? The issue is that MkDocs relies on the files.src_uris to look for the valid assets when it resolves links in Markdown and you're reconstructing the mapping for each language build.
I do realize this issue could be also related to other directories, assuming someone uses files/ as their assets/ prefix. So perhaps adding some global list of strings (mkdocs config setting) with prefixes to always include would be beneficiary.
ultrabug
The regressions might have been present in version 1.0.0, but I haven't verified it. I simply used the latest available version. Some of these issues could be intentional (though I hope not). Please consider this a mega-thread of challenges I faced while migrating to the newer version. 😃
Environment:
i18n 1.0.2 plugin config
```yml - i18n: docs_structure: suffix languages: - name: en - English locale: en default: true build: true nav_translations: Afsp: AFSP Anims: Animations Contribute: How To Contribute Daedalus tools: Daedalus General info: General information Genome: Genome (G3/R1) Lego: LeGo Vdfs tools: VDFS Zengin: ZenGin (G1/G2) Zgamepad: zGamePad Zparserextender: zParserExtender - name: pl - Polski locale: pl default: false build: !ENV [GMC_ENABLE_ON_PUBLISH, True] site_description: 'Gothic Modding Community to zbiór pomocnych materiałów do modowania gier Gothic i Risen.' nav_translations: Anims: Animacje Applications: Zastosowania Classes: Klasy Contribute: Jak Się Udzielić Examples: Przykłady Extenders: Extendery Extensions: Rozszerzenia Functions: Funkcje General info: Informacje ogólne Home: Strona Główna Plugins: Wtyczki Scripts: Skrypty Sound: Dźwięk Standalone: Samodzielne Syntax extensions: Rozszerzenia składni Tools: Narzędzia Tutorials: Poradniki Various: Różne Worlds: Światy - name: cs - Čeština locale: cs default: false build: !ENV [GMC_ENABLE_ON_PUBLISH, True] site_description: 'Dokumentace, návody a články zaměřené na modování her Gothic a Risen.' ```File structure
https://tree.nathanfriend.io/ ``` . ├── docs/ │ ├── some_dir/ │ │ └── some_more_dirs │ ├── index.md # Default language AND fallback │ ├── index.pl.md # Polish language │ └── index.cs.md # Czech language ├── overrides/ │ ├── assets/ │ │ ├── images/ │ │ ├── javascript/ │ │ └── stylesheets/ │ └── main.html └── mkdocs.yml ```Issues:
Relative Path Warnings: When building subsequent languages, warnings appear for relative paths to the overrides directory (no issues for the default language).
There's only a default language version of the file, and when the Polish version falls back to it, the path doesn't match. This warning wasn't present in plugin version 0.5.6* with MkDocs 1.5.2, although the error was partially there. With my MkDocs configuration using directory paths, the path gets altered with an additional
../for the default language. In version 0.5.6, the paths in other languages were consistent with the default language. However, in version 1.0.2, they remain as is in the Markdown.Global Parameters: The previous
default_languageanddefault_language_onlyparameters were handy for CI and making swift local development changes using environment variables (GMC_DEFAULT_LANG,GMC_ONLY_DEFAULT_LANG). The new config seems to have reversed the behavior, making the default language obligatory. I might be able to work with that, but the subsequent issue is more concerning.Language Toggling Issues: Given that each language now has an individual toggle for
default, it's not feasible to set a single environment variable. In addition, swapping the values temporarily (e.g., en <-> pl) is currently not possible due to the existing file structure:The latest version seems to connect
defaultwithfallback. This results in a conflict when I aim to useindex.pl.mdas the default, while intendingindex.mdto act as a fallback for the English version. I certainly don't intend to alter the file structure to accommodate files likeindex.en.md.Build Time Logs: The output displays individual build times for each build rather than a single cumulative log at the end.
I recall somewhat resolving this to show only the final time log, but maybe MkDocs 1.5 altered the way duplicate filters operate.
These are my primary concerns for now. I'll update this list as I progress further.
*Note: While I did use a modified variant of plugin version 0.5.6, to the best of my recollection, none of the regressions mentioned were connected to those modifications. See modifications here.