Read the docs at docs.vapor.codes
- Prerequisite for this setup, you must have docker and docker compose installed on the system
-
first clone the repo
-
then run
docker compose up
- then open from the browser on the port 8000 e.g.
http://127.0.1.1:8000
If you want to add information to the docs or have found any mistakes you wish to fix, feel free to create a PR for the change.
Localised docs are incredibly useful for allowing people to learn Vapor in their native language. If you wish to contribute to the Vapor documentation by translating, follow the steps below.
The docs are generated with Kiln, a documentation site generator written in Swift, so you'll need a Swift 6.2+ toolchain (no Python required). Build the site by running swift run VaporDocs in the root of the repository; the generated site is written to the site/ directory.
The site is configured in Swift in Sources/VaporDocs/main.swift. Check whether the language you want to translate to is already in the languages array. If not, add it:
Language(
.dutch, // a built-in LanguageCode, or .custom(code: "xx", name: "…")
siteName: "Vapor Documentatie",
description: "Vapor documentatie (webframework voor Swift).",
navTranslations: [
"Welcome": "Welkom",
"Install": "Installeren",
],
localisation: .init(
searchPlaceholder: "Zoeken"
// … other UI strings; any left unset fall back to English
)
)Navigation titles are translated via navTranslations, keyed by the English title used in the navigation tree. The theme's own UI strings (search box, "previous"/"next", error page, …) are translated via localisation.
Copy the markdown file you would like to translate and name it <original file name>.<language code>.md. For example:
- index.md <- the original English documentation
- index.nl.md <- the Dutch translation
You can preview your changes by running swift run VaporDocs and serving the output, e.g. python3 -m http.server --directory site. Once you are satisfied with your translations, feel free to create a PR.
NOTE: If a file isn't translated, it will just default to the default language file. So you don't have to translate everything all at once.
Finally, you should add the new language to the issue template to ensure that any future changes are applied to the new translation and to the search index script to ensure search works correctly.
Except where otherwise noted, Vapor Documentation by Vapor is licensed under CC BY-NC-SA 4.0 
