Quant Wiki: a Chinese-language quantitative finance wiki built with MkDocs

What Quant Wiki actually is, and who it is for

Quant Wiki is a documentation project. The README describes it as a free and open platform for sharing quantitative finance knowledge, covering core quant trading concepts, common models, algorithm design and practical strategies, with material on factor models, event-driven strategies and execution cost optimisation. The stated goal is to open-source and localise quantitative knowledge and to close the information gap between the domestic and international quant industries.

The repository layout matches that description: a docs/ directory, an mkdocs.yml configuration file, a requirements.txt pinning the build toolchain, and a README. There is no trading engine, no backtester and no data loader. Anyone who arrives expecting installable Python that produces signals will be disappointed, and that mismatch is worth stating plainly because the name suggests a library to some readers.

The audience is narrower than "quant developers". It is Chinese-reading students and practitioners who want structured material on factor models and execution costs, plus contributors willing to translate or write pages. The README notes the project draws inspiration from OI Wiki, the Chinese competitive-programming knowledge base, and says it borrowed from OI Wiki's approach to content organisation, writing conventions and site architecture. That lineage explains the shape of the repository: a static MkDocs site edited through pull requests rather than a package with a versioned API.

The MkDocs pipeline behind quant-wiki.com

The site is generated by MkDocs 1.6.1 with the Material theme, mkdocs-material 9.5.49. Supporting packages in requirements.txt show what the build does beyond rendering Markdown: mkdocs-minify-plugin 0.8.0 with csscompressor, htmlmin2 and jsmin compresses the generated HTML, CSS and JavaScript; pymdown-extensions 10.13 supplies the Markdown extensions; babel 2.16.0 and Pygments 2.18.0 handle localisation and syntax highlighting. watchdog 6.0.0 is present, which is what makes mkdocs serve rebuild on file changes.

So the data flow is conventional for a docs site. Markdown files under docs/ are the source of truth. mkdocs.yml holds navigation, theme and plugin settings. Running the build produces a static site, which is what quant-wiki.com serves. There is no database, no API and no runtime component.

That choice has consequences worth naming. A static site is cheap to host and easy to review through pull requests, which suits a volunteer translation effort. It also means the project cannot ship executable examples that a reader runs in place. Any code shown on a page is prose, not a tested artefact. For a wiki that is acceptable; for a tutorial series it becomes a maintenance problem, because nothing in the toolchain verifies that a snippet still works.

Installing Quant Wiki and previewing it locally

The README gives the local deployment steps directly. Clone the repository and enter the directory:

git clone https://github.com/LLMQuant/quant-wiki.git
cd quant-wiki

The README recommends a venv virtual environment, then installing the pinned dependencies from requirements.txt:

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

On Windows the activation line differs from the one shown here; the README only prints the POSIX form. After the install completes, the README says local preview needs a single command:

mkdocs serve

MkDocs serves the site on localhost and rebuilds when files under docs/ change, since watchdog is in the dependency list. Open the printed address in a browser and you should see the same navigation and pages as the public site, rendered from your working copy. If the build fails, the first thing to check is that the Python version on your PATH matches what the pinned packages expect, because requirements.txt fixes exact versions (mkdocs==1.6.1, mkdocs-material==9.5.49) rather than ranges.

To contribute, the README points at CONTRIBUTING.md in the .github directory. The README does not document a deployment command for publishing to quant-wiki.com, so treat local preview as the only workflow described in the repository.

What the repository does not tell you

Several things a reader would reasonably want are absent. The README states the project is under development and invites contributions, but it does not describe a review process, a translation backlog, a page template or a style guide beyond the pointer to CONTRIBUTING.md. There is no changelog and no release history, so there is no way to tell from the README which pages are complete and which are stubs.

The licence section is explicit, but its consequences are easy to miss. Quant Wiki uses CC BY-NC-SA 4.0. You may share and adapt the work with attribution, you may not use it commercially, and adaptations must carry the same licence. For a wiki about trading, that last point matters more than it looks: a reader who lifts a factor-model explanation into internal training material at a fund is using it commercially, and the licence does not permit that. The licence text also states that no warranty is provided and that other rights, such as personality or privacy rights, may further limit use.

There is also a practical gap between the project's bilingual ambition and its delivery. The stated mission is to bridge domestic and international information gaps, yet the repository is a Chinese-language wiki. The README does not document an English edition, a translation workflow or a language switcher in mkdocs.yml. If you cannot read Chinese, the content is not currently aimed at you.

Quant Wiki compared with a code-first quant library

The obvious alternative for someone who wants working quant code is a Python backtesting or research library, where the deliverable is importable modules and the documentation exists to explain an API. The difference is not quality, it is category. A library ships functions with versioned behaviour and tests; Quant Wiki ships pages, and its requirements.txt pins the tool that renders those pages, not a trading stack.

A second comparison is with a general-purpose wiki or a personal notes repository. Those give an author full freedom over structure and no editorial friction. Quant Wiki trades that freedom for a shared navigation tree, a fixed theme and a licence that keeps derivatives open. The cost is that a contributor must fit their material into the existing MkDocs structure and accept that their page can be edited by others.

The OI Wiki comparison the README makes is the most useful one. OI Wiki succeeded because competitive programming has a stable, well-defined body of knowledge and a large pool of students who benefit from writing it down. Quantitative finance is less settled: strategies decay, execution cost models depend on venue and era, and much practical knowledge sits behind employment agreements. That makes a community wiki harder to keep accurate, and it is the main risk a reader should weigh.

Maintenance, licence and the cost of contributing

The repository is not archived, and the last push was on 2026-04-16. That is roughly five months before the date of writing, so the project is not abandoned, but it is also not receiving daily commits. For a wiki, a slow cadence is normal; content changes arrive in bursts when contributors have time.

Upgrade cost is low by design. The dependency set is small and fully pinned, so a fresh clone reproduces the same build months later. The flip side is that pinned versions age: when you eventually bump mkdocs or mkdocs-material, the minify plugin and pymdown-extensions are the packages most likely to need matching updates, because they hook into the build rather than sitting beside it. There is no CI configuration visible in the top-level entries beyond the .github directory, so the repository does not document an automated build check.

On licensing, the practical points are these: attribution is required, commercial use of the content is not permitted, and derivative works must be shared under the same terms. If you plan to mirror pages, translate them into another language, or fold them into a paid course, the licence governs that, and the README's own summary is described as a summary rather than a substitute for the full legal code. This is a description of the terms, not legal advice; check the licence text and your own obligations before redistributing anything.

Editorial conclusion

Adopt Quant Wiki if you read Chinese and want a free, community-edited reference on factor models, event-driven strategies and execution cost optimisation, or if you want to contribute Chinese translations of English quant material. Do not adopt it if you need a Python library that computes signals, or if your use is commercial: the CC BY-NC-SA 4.0 licence forbids commercial use of the content. Verify first that mkdocs serve renders the docs/ tree cleanly on your machine, that the pages you rely on are not stubs, and that the licence terms fit how you plan to redistribute anything you copy.

Frequently asked questions

Official sources

1. Issues
2. LLMQuant/quant-wiki on GitHub
3. Project website
4. README