Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time
September 21, 2023 15:54
August 13, 2021 09:25
June 20, 2022 13:02
May 30, 2023 18:01

GL.iNet documentation

This repository is the source code for documentation of GL.iNet routers firmware 3.x


Build by mkdocs 1.2.2, with theme mkdocs-material 7.2.2

Using python 3.x virtual environment, create a virtual environment, activate it, git clone this project source code inside it. There is a requirements.txt file in the project, run the command below to install packages.

pip install -r requirements.txt

Online View

Please view the docs online at


Markdown syntax

Each page use markdown, please check out this basic syntax of markdown here.

Open in new tab

If you wanna a link to open in new tab, add {target="_blank"} at the end of link block.

Image file type

Prefer to use png.

Image lightbox

If the size of image is too big, please use the PhotoSwipe, check out here.

Image captions

  <img src="" width="300" />
  <figcaption>Image caption</figcaption>

About plugin PhotoSwipe

Using the v4 version, v5 version looks better, but need to load js module. Don't know how to work it out in mkdocs.

Suggest to use PhotoSwipe when the width of image is large than 1021px.

<div class="gl-lightbox" itemscope itemtype="">
  <figure itemprop="associatedMedia" itemscope itemtype="">
    <a href="" itemprop="contentUrl" data-size="3167x2480">
      <img src="" itemprop="thumbnail" alt="gl-b2200 pcb pinout" />


About versoning

There is a plugin named mike is for versoning, it need to deploy with Github Page, but I don't use Github Page, I just copy the file structure like mike does. Please check out mkdocs-material-example-versioning, and switch to gh-pages branch.


Setting up versioning