gl-inet / docs4.x

GL.iNet Documentation This repository contains the source files for GL.iNet router firmware 4.x documentation. It is now a multilingual documentation repository. The current language sites in this repo are: • English: • German: • Spanish: • Japanese: Each language has its own , , and directory. Environment The documentation is built with MkDocs 1.5.3 and the Material for MkDocs theme 9.4.6. Installation Create a Python virtual environment: Activate the virtual environment, then install dependencies: You can also install Material for MkDocs directly: Reference: https://squidfunk.github.io/mkdocs-material/getting-started/#with-pip Repository Structure The root folder contains one MkDocs project per language: In most cases, localized pages should mirror the corresponding English page path under . Local Preview Run MkDocs against the language you want to preview. Examples: If you are reviewing or translating localized content, open the English source page and the matching localized page side by side in VS Code. Online View Published documentation: • English: https://docs.gl-inet.com/router/en/4/ • German: https://docs.gl-inet.com/router/de/4/ • Spanish: https://docs.gl-inet.com/router/es/4/ • Japanese: https://docs.gl-inet.com/router/jp/4/ Writing Guide Markdown Syntax All pages are written in Markdown. For basic syntax, see Markdown Guide. Open a Link in a New Tab To open a link in a new tab, add at the end of the link. Image File Type Prefer PNG unless there is a clear reason to use another format. Image Lightbox If an image is large, use PhotoSwipe. See About PhotoSwipe. Image Size Use , , , , or to control image width on desktop. Example: Image Shadow Effect Use to add a shadow to an image. Example: Image Captions Internal Links Use relative paths for internal links. About PhotoSwipe This project currently uses PhotoSwipe v4. Version 5 looks better, but it requires loading JavaScript modules and is not integrated here. Use PhotoSwipe when the image width is larger than 1021 px. Reference: • https://photoswipe.com/documentation/getting-started.html • https://codepen.io/dimsemenov/pen/ZYbPJM About Versioning The plugin is designed for versioned MkDocs deployments, usually with GitHub Pages. This repository does not deploy with GitHub Pages, but it follows a similar output structure. Reference: • Setting up versioning • mkdocs-material-example-versioning