The AList docs site is a VuePress app with a home page built from YAML

The home page is configuration, not prose

The most unusual thing about the AList documentation site is that its landing page has no Markdown content at all. The whole page is a YAML frontmatter block that the theme turns into a hero, a set of feature cards and a footer.

The block opens with the routing and branding keys, `home: true` to mark it as the home page, an iconfont icon, a title of Home, a hero image of /logo.svg, heroText of ALIST, and a tagline describing it as a file list program that supports multiple storage, powered by Gin and Solidjs. Then come the action buttons, Get started pointing at /guide/ as the primary action and a GitHub link.

What follows is a `features` list, and each entry has a title, an icon and a details string. Easy to Use, with the note that AList was designed from the ground up to be easily installed and can be used on all platforms. Multiple storage, naming local storage, Aliyundrive, Onedrive and Google Drive among the providers, and saying it is easily expand. Support WebDAV, described as a standard for accessing files on. Dark Mode, where you can switch between light and dark freely. Protected routes, adding password protection and authentication for a specific path.

Then the file preview entry, which covers video, audio, office, pdf, code and image preview and even ipa install. Package download and batch download, using the stream api of the browser to support package download without server usage, and batch download of a folder using Aria2. Single sign-on, and automatic registration of an AList account through it.

The last three are offline download of torrent content to a specified directory, which needs a good network environment. Crypt encrypt and decrypt of files, where data is stored in a Crypt and the provider can only see the Crypt, not your data. And a catch-all for more new features, including a text editor, readme and html render, file permalink, and a cloudflare workers proxy.

So the home page is doing double duty as a feature specification, which is why it is worth reading as a document rather than skipping past.

The toolchain is VuePress with a lot of release candidate versions

The package file shows the documentation build, and the dependency list explains the feature set of the site itself.

The base is VuePress 2 with the Hope theme, both at `^2.0.0-rc.19` and `^2.0.0-rc.71`. The bundler is the Vite-based one, and Vue and VueUC are the runtime pieces. Docsearch is the search plugin, and there is a plugin-docsearch package with its own release candidate.

The interesting part is the long tail of rendering libraries, because each one corresponds to a class of content the docs need to display. artplayer and dashjs and hls.js and mpegts.js cover video playback in several protocols. echarts and chart.js cover charts. mermaid and flowchart.ts cover diagrams. mathjax-full covers math. sass covers styling.

The scripts section is short and tells you the working day loop. `docs:dev` runs vuepress dev on the docs directory, `docs:clean-dev` does the same with the cache cleared, `docs:build` runs a production build, and `dev` is an alias for docs:dev. There is also an `ecosystem` script that runs `npx tsx scripts/ecosystem.ts`.

That last one is the most interesting for a reader. The AList landing page claims support for multiple storage providers and says the project is easily expand, and the ecosystem script hints that the provider catalogue is maintained by tooling rather than typed by hand, though its exact output is not documented here.

The project pins pnpm as its package manager at 9.9.0, and the repository carries a.nvmrc for the Node version, a.npmrc, a.prettierrc, a renovate.json for dependency updates and a scripts/ directory.

What the documentation is actually for

This repository documents AList v3, and the split with the server code is worth understanding before anyone contributes.

The package description says it plainly: documentation for alist v3, with a link to the AList repository and a homepage for the project itself. The repository layout follows. There is a docs/ directory holding the content, scripts/ for the tooling including the ecosystem generator, and a small set of configuration files at the root.

So a change to how a feature is described is a change here, and a change to how the feature works is a change in the server repository. The two are edited by different people on different schedules, which is the normal split for a project with a large user base and an active core team.

The audience the feature list describes is a self-hosted user. The people who install AList are running it on their own server or their own NAS, mounting storage providers they already pay for, and exposing that storage through a web interface or WebDAV. Everything in the feature list follows from that: WebDAV support so other tools can read the mount, offline download so a torrent can be fetched to a directory, protected routes so a subpath needs a password, and Crypt encryption so a storage provider never sees the data.

That last point is the one that reads most carefully, because it is a specific architectural claim rather than a feature name. Data is stored in a Crypt and the provider can only see the Crypt, not your data. The claim is that the upload is opaque to whoever stores it, which is a different guarantee from password-protecting a path.

The footer carries the licence line and the deployment badge

Two small pieces of the frontmatter are worth pulling out, because they are the kind of detail that changes what you can do with the site.

The first is `copyright: false`, which suppresses the theme's default copyright notice. The second is the footer, which is a raw HTML string rather than a theme key. It contains a Netlify badge linking to netlify.com, and a div reading AGPL-3.0 Licensed with a copyright line for 2022-present AList.

That footer tells you the documentation site is hosted on Netlify, which is the deployment target the badge is advertising.

It also introduces a licence wrinkle worth flagging. The licence field for the project is Apache-2.0, and the footer text says AGPL-3.0. The package file records the licence as AGPL-3.0 as well, for the package named alist-doc at version 3.0.0, while the footer attributes copyright to AList rather than to this repository. The documentation for AList itself is AGPL-3.0, and the site code carries Apache-2.0. The distinction makes sense if you read it as the documentation content being AGPL and the tooling around it being permissively licensed, but it is the kind of thing to read directly rather than assume before you reuse the content.

There is no homepage field in the package file for the site itself, and the project homepage recorded for the repository is alist.nn.ci.

Where this sits against the AList server repository

The honest comparison is between this site and the alternatives for hosting documentation, and the choice here is deliberately unfashionable.

A Docusaurus or Next.js site with a static build pipeline would be the modern default, and either would give you component libraries and a larger ecosystem. VuePress 2 on top of Vite is the same idea from the Vue ecosystem, and the Hope theme supplies the navigation, search and layout rather than the project hand-rolling them.

The dependency list shows a deliberate difference from a typical docs site. There is no CMS integration, no comments package, no analytics or i18n stack. Instead there is a set of content-rendering libraries chosen for what the documentation has to show: video in several streaming formats, diagrams in two syntaxes, charts, and math. Those libraries exist to render exactly that kind of embedded content.

The other thing worth noting is the ecosystem generator. In a project where a third party can add a storage driver, the provider list is a moving target, and generating it from a script keeps the home page honest. That is a small decision that would be invisible in a screenshot of the site and quite visible if it were wrong.

What this repository is not is a template you can lift for unrelated documentation. The frontmatter, the theme, the hero and the feature cards are all specific to AList, and the ecosystem script is specific to how AList tracks storage providers.

Editorial conclusion

Adopt this repository if you are deploying or extending AList v3 and want the same documentation surface the project ships, since the VuePress setup with the Hope theme, search, diagram and video support is already configured. Skip it if you are looking for the AList server itself, which lives in a separate repository, or if you only need the API, because the code here is a documentation site rather than a service. Verify first which VuePress version you want, since every VuePress dependency is pinned to a release candidate, and how the ecosystem script fits into the workflow.

Frequently asked questions

Official sources

1. AlistGo/docs on GitHub
2. Issues
3. License: Apache-2.0
4. Project website
5. README