Added multi language support for document site by Metallist1 · Pull Request #272 · TabularEditor/TabularEditorDocs

Metallist1 · 2026-02-27T13:51:15Z

Added multi language support
Redone how docfx is generated. Switched to a python script.
Added a language picker.
Added a dynamic way to populate language picker. Creating a folder and adding a language to a language manifesto allows you to insert a new language without modifying other files.
Added a banner for languages which states "This text is made by AI and has not been reviewed by a human".
Adjusted redirections and modified 404 heavily to account for legacy urls. (/getting-started/index.html redirects to /en/getting-started/index.html).
Adjusted 404 to also distinguish between accessing an unsupported language and a wrong page. Example, we do not support french so if you navigate to "/fr/getting-started/index.html", 404 promts the user to see all supported languages.
If you navigate to a non existent page eg. /en/not-getting-started/index.html. It tells the user, the page does not exist.
Added SEO support for language switching.
Added a way to translate the header using _ui-strings.json. All header elements are supported for the translation.
Added a way to sync content with existing translations. Avoiding potential stale data. If a file is edited in the content - it will be replaced in the translation. If a file is deleted in translation - it will be regenerated on build.
Pipelines have been adjusted to account for the new multi languages.
Added a fallback option to languages that defaults to english.
Fixed broken header search bar

Note: In this PR i did not include the english fallback to any translations as they would be automatically generated on run. Additionally, they distract from the purpose of this review as it would be duplicating the website 3 times. I encourage to create a separate PR with the generated english fallbacks once we are ready to use crowdin.

Additional things:

English will redirect to /en/. This is due to consistency and that maintaining "/" seemed like a lot more work than just having a unified system for all languages even if english is our main language.
I did not add staticwebapp.config to gitignore due to maintaining legacy implementation. However, modifying it past this PR is no longer necessary as it will be automatically regenerated.
I changed "Sign in" to "Main page" as I do not believe "Sign in" is accurate. This can be easily modified with modifying text in _ui_strings.json

* added simple support * Grouped tranlsations * Saving progress * Changed crowdin path and localized content to include whats-new * Added changes to create dynamic staticapp and dynamic language population and a custon 404 to allow for easier language selection and dynamic redirection to home * Started standardising scripts. * Saving progress. Split up some responsabilities. Renamed folders to be more accurate. Fixed redirects. * Added a way to sync files. * Removed old script * Started documentation --------- Co-authored-by: Nedas <nedas.surkus@tabulareditor.com>

github-actions · 2026-02-27T14:04:01Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

github-actions · 2026-02-27T15:59:31Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

github-actions · 2026-02-27T16:25:02Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

github-actions · 2026-02-27T16:32:08Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

github-actions · 2026-02-27T16:46:21Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

github-actions · 2026-02-27T18:53:15Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

github-actions · 2026-02-27T19:07:13Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

github-actions · 2026-02-27T19:18:13Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

github-actions · 2026-02-27T20:09:12Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

…irects and updated readme files. General clean up. Added missing support for whats-new.

github-actions · 2026-03-02T10:24:18Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

…ng for docfx. Added a trailing line fix

…abularEditor/TabularEditorDocs into feature/multilang-support_5604

github-actions · 2026-03-02T10:38:33Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

Metallist1 · 2026-03-02T11:18:04Z

.github/workflows/deploy.yml


 jobs:
-  build_and_deploy_job:
+  build_job:


The reason why we have to split the build and deploy jobs is simply due to the fact that the API folder would not be properly generated for translations.

Build runs on a windows-latest and deploy on ubuntu-latest.
Using windows -latest allows us to generate the dlls necessary for API folder population.

Using ubuntu-latest allows us to deploy to azure functions.

Metallist1 · 2026-03-02T11:21:14Z

content/404.html

 <!DOCTYPE html>
 <html>
 <head>
+    <meta charset="utf-8">


The reason why 404 was changed so heavily is to account for the fact that we need 3 different scenarios.

Using legacy redirects. If a user has saved it as https://docs.tabulareditor.com/api/index.html , we wish to redirect him to https://docs.tabulareditor.com/en/api/index.html

We wish to display all available languages to the user if they try to use a non supported language for example "https://docs.tabulareditor.com/fr/api/index.html"

We wish to display a different 404 in the case that the user misspelled the URL incorrectly. Ex: https://docs.tabulareditor.com/api/broken-link/index.html

Accounting for all 3 makes it necessary to change 404 heavily.

Metallist1 · 2026-03-02T11:22:41Z

_site/staticwebapp.config.json

@@ -1,142 +1,278 @@
 {


There is little point of adding any changes to staticwebapp.config.json anymore.
The reason is that this is automatically regenerated on run using gen_staticwebapp_config.py

The reason for it is is simply to ensure that all redirects have proper status codes for SEO purposes.

Metallist1 · 2026-03-02T11:24:02Z

content/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">


We need this default as a deployed app needs a fallback when we use multiple languages to communicate that by default we use english.

Metallist1 · 2026-03-02T11:24:41Z

content/toc.yml

 - name: References
  href: references/
-  homepage: references/index.md 
+  homepage: references/index.md


These changes are not really relevant. They do not change anything. But when generating the toc.yml for the localizedContent would be not the same

Metallist1 · 2026-03-02T11:27:46Z

metadata/build-config.json

+      "security",
+      "troubleshooting",
+      "tutorials",
+      "whats-new"


We maintain an html file for "whats-new". This will not be translated by crowdin. We might want to figure out a workaround for this by either converting "whats-new" to .md (I understand there is an instance of it in /references but I lack the context to make a decision on what to delete).
Or alternatively we can just specify that crowdin should translate HTML as well. This probably has no conflicts but it is out of scope to check

Metallist1 · 2026-03-02T11:29:11Z

metadata/language-metadata.json

+  "_comment": "Language display names and metadata. Add entries here for new languages.",
+  "defaultLanguage": "en",
+  "languages": {
+    "en": { "name": "English", "nativeName": "English" },


I added some languages as just preparation. But generally, whenever we add a new language, we should modify this manifesto to include rich data such as native name and an english name.

I do consider this as an easy maintenance task that is documented in README.md

Metallist1 · 2026-03-02T11:29:52Z

templates/tabulareditor/layout/_master.tmpl

                    {{#subMenu}}
                      <li class="main-nav__list-item main-nav__list-item--lvl1 lvl1 main-nav__list-item--dropdown">
-                        <a class="main-nav__list-item-link main-nav__list-item-link--lvl1 lvl1 main-nav__list-item-link--dropdown-toggle" href="#" aria-haspopup="true" aria-expanded="false" role="button" data-bs-toggle="dropdown" target="_self"> {{text}} </a>
+                        <a class="main-nav__list-item-link main-nav__list-item-link--lvl1 lvl1 main-nav__list-item-link--dropdown-toggle" href="#" aria-haspopup="true" aria-expanded="false" role="button" data-bs-toggle="dropdown" target="_self"{{#uiStringKey}} data-ui-string="{{uiStringKey}}"{{/uiStringKey}}> {{text}} </a>


This is one way to translate all headers with crowdin.

Metallist1 · 2026-03-02T11:30:25Z

templates/tabulareditor/README.md

+For windows
+
+```bash
+npm run build


Added tutorial for windows generation. Despite the fact that templates cannot be generated in this project.

Metallist1 · 2026-03-02T11:31:00Z

.gitignore

 target/
-/_site/*
-!/_site/staticwebapp.config.json
+/_site/


Again. regarding the staticwebapp.config.
It is now regenerated automatically. No need to include it anymore.

Metallist1 · 2026-03-02T11:32:22Z

.gitignore

+/_site/
+
+# Localized content
+/localizedContent/en/


/en/ is just a copy of content. There is little point in adding it as we will not be using crowdin to translate it.

However, we should maintain translation status. This keeps track on all content that was copy pasted from /content and it is used for comparison and syncing that no value is static.

Metallist1 · 2026-03-02T11:39:45Z

crowdin.yml

  {
    "source": "/content/404.html",
-    "translation": "/localizedContent/%two_letters_code%/404.html"
+    "translation": "/localizedContent/%two_letters_code%/content/404.html"


The changes here are quite simple in nature.

Due to how we previously designed the website, our docfx always gets information from /content/.
Additionally many picture URLs reference /content/* as their path. While I could change this and reduce the need to have an additional folder - It is too much effort for this PR.

It is also just an asthetic change.

NOTE:
You might try to argue that it might be a good idea to just have a global folder for content we do not translate. I agree but docfx does not. It requires the docfx.json to be in a root directory and as such, if you change the image paths to "../content" or something similar, it will throw out an error that specifies that it has too many redirections.

For now, we are copying all the file contents TO localisedContent as a workaround. It is not a pretty but it works.

One benefit of it is that it would allow the API and images to eventually be translated. For images specifically we could set up a macro that 1. opens tabular editor. 2. Navigates to where the image should be present. 3. takes a picture. 4. Switches language. 5. Repeat 3-4 until all available languages are covered. 6. Replaces the existing images with new images.

Metallist1 · 2026-03-02T11:41:18Z

README.md

 To test your changes locally:
- Make sure [DocFX](https://dotnet.github.io/docfx/) is installed.
- Run `gen_redirects.py` in the root of the project.
- Run `docfx --serve` in the root of the project.


Generally since we never generate docfx in root anymore. There is no point in having these instructions. Instead do use python build-docs.py --serve , py build-docs.py --serve or & "$env:USERPROFILE\.local\bin\python3.14.exe" build-docs.py --serve depending on your python setup

Metallist1 · 2026-03-02T11:41:31Z

redirects.json

@@ -1,228 +0,0 @@
-{
-  "content/common/CSharpScripts/Advanced/script-add-databricks-metadata-descriptions.html": "/features/CSharpScripts/Advanced/script-add-databricks-metadata-descriptions.html",


moved into metadata

Metallist1 · 2026-03-02T11:44:22Z

build_scripts/inject_seo_tags.py

+
+
+# Default base URL for the documentation site
+DEFAULT_BASE_URL = "https://docs.tabulareditor.com"


Might be a good idea to pull this out into metadata. But for now we know it will be used only in https://docs.tabulareditor.com so I am not quite sure on this.

github-actions · 2026-03-02T12:06:27Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

github-actions · 2026-03-02T12:24:41Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-272.westeurope.azurestaticapps.net

Metallist1 and others added 4 commits February 27, 2026 14:41

Adjusting deployment pipeline

768366a

Trying to fix an error

0f7e2a3

Changed site location

cdcf251

Changed design to better fit the requirements

80ec835

Preserve trailing slashes

203fa68

Changed build to include api

1c32d3a

Metallist1 force-pushed the feature/multilang-support_5604 branch from 4cbf5b6 to 1c32d3a Compare February 27, 2026 18:59

Nedas added 2 commits February 27, 2026 19:59

Added a windows mode to allow api generation

7ff16a5

Checked to two jobs

48fc1aa

Added output for testing

4228bea

Fixed graphical errors. Added a way to translate header strings

1c573ee

Metallist1 marked this pull request as ready for review February 27, 2026 20:22

Nedas and others added 3 commits March 2, 2026 11:02

Updated headers to support translation strings. Cleaned up unused red…

5b6884a

…irects and updated readme files. General clean up. Added missing support for whats-new.

Added legacy urls such as kb and API to be excluded from 404 check

c636bda

Merge branch 'main' into feature/multilang-support_5604

5146d12

Nedas added 2 commits March 2, 2026 11:33

Updated deploy.yml to a never version of setup-python and added cachi…

cf0ed35

…ng for docfx. Added a trailing line fix

Merge branch 'feature/multilang-support_5604' of https://github.com/T…

6b5cbc9

…abularEditor/TabularEditorDocs into feature/multilang-support_5604

Metallist1 requested a review from otykier March 2, 2026 10:40

Metallist1 self-assigned this Mar 2, 2026

Metallist1 requested a review from mlonsk March 2, 2026 10:40

Metallist1 commented Mar 2, 2026

View reviewed changes

Added search fix

2e0a212

Removed early exit for english translation to apply ui strings properly

9904866

		@@ -1,228 +0,0 @@
		{
		"content/common/CSharpScripts/Advanced/script-add-databricks-metadata-descriptions.html": "/features/CSharpScripts/Advanced/script-add-databricks-metadata-descriptions.html",



		# Default base URL for the documentation site
		DEFAULT_BASE_URL = "https://docs.tabulareditor.com"

Conversation

Metallist1 commented Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 27, 2026

Uh oh!

github-actions bot commented Feb 27, 2026

Uh oh!

github-actions bot commented Feb 27, 2026

Uh oh!

github-actions bot commented Feb 27, 2026

Uh oh!

github-actions bot commented Feb 27, 2026

Uh oh!

github-actions bot commented Feb 27, 2026

Uh oh!

github-actions bot commented Feb 27, 2026

Uh oh!

github-actions bot commented Feb 27, 2026

Uh oh!

github-actions bot commented Feb 27, 2026

Uh oh!

github-actions bot commented Mar 2, 2026

Uh oh!

github-actions bot commented Mar 2, 2026

Uh oh!

Metallist1 Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Metallist1 Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 2, 2026

Uh oh!

github-actions bot commented Mar 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Metallist1 commented Feb 27, 2026 •

edited

Loading

Metallist1 Mar 2, 2026 •

edited

Loading

Metallist1 Mar 2, 2026 •

edited

Loading