Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Once reviwed by the community, and any feedback has been taken care of, your pul

### Translating articles

Coming soon.
Read [How to translate a Knowledge Base article](/general-support/translate-a-knowledge-base-article/) for a step-by-step guide to adding translated articles.
94 changes: 94 additions & 0 deletions content/General Support/translate a knowledge base article.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
title: "How to translate a Knowledge Base article"
date: "2026-05-13"
order: "095"
---

### Choose an article to translate

Start by finding an English Knowledge Base article that does not already have a translation in your language. Articles are stored in the `content` folder and use a language suffix in the file name.

For example, the English article for contributing to the Knowledge Base is:

```text
content/General Support/contribute to the knowledge base.en.md
```

A Spanish translation of the same article would use the same folder and article name, but replace `en` with the ISO 639-1 language code:

```text
content/General Support/contribute to the knowledge base.es.md
```

### Copy the English article

Copy the English `.en.md` file you want to translate and rename the copy with the language code you are adding. Do not edit or remove the English article.

Keep the translated article in the same category folder as the original article. This keeps the Knowledge Base navigation grouped correctly.

### Translate the front matter

Every article begins with a header section between `---` lines. This is called front matter. Translate the article title, but keep the field names the same.

For example:

```yaml
---
title: "How to contribute to the NavCoin Knowledge Base"
date: "2019-03-21"
order: "090"
---
```

When translated, only the text values should change:

```yaml
---
title: "Como contribuir a la base de conocimiento de NavCoin"
date: "2019-03-21"
order: "090"
---
```

Do not translate field names such as `title`, `date`, `draft`, `type`, or `order`. Do not change the `order` value unless the article needs to move within its category.

### Translate the article body

Translate headings, paragraphs, list items, and image alt text. Keep Markdown syntax intact so the article still renders correctly.

Preserve links, image paths, and code blocks unless they need to change for the translated article. For example, keep links such as:

```markdown
[KnowledgeBase](https://github.com/NAVCoin/KnowledgeBase)
```

If the article includes screenshots with English interface text and translated screenshots are necessary, add the new images to `static/images` and update the image links in your translated article.

### Preview the site

If you have Hugo installed, run the site locally from the repository root:

```bash
hugo server
```

Open the local preview URL and check that:

- the article appears in the correct category
- headings, links, images, and code blocks render correctly
- the page works on desktop and narrow mobile widths

If you cannot run Hugo locally, review the Markdown carefully and use the Netlify deploy preview that appears after opening the pull request.

### Submit the translation

Commit the translated article to your fork and open a pull request to the `NAVCoin/KnowledgeBase` repository.

In the pull request description, include:

- the article you translated
- the language code you added
- any screenshots you added or changed
- the preview link, if available

Once the pull request is reviewed and merged, the translated article will be published with the rest of the Knowledge Base.