Documentations for X, Modernized

Take a look at the website!

mirror of X.org official docs (version 11, release 7.7)

Ported and converted by Yuxuan Zhang

TODO LIST

• Implement outline detection and source segmentation for html transform.
• Add auto deploy to github Actions.
• Fix code block highlighting (defaults to C syntax)
• Make external links look different
• Add links to x.org original pages

Develop or build locally

1. Install npm packages

   $ npm install

2. Setup Markdown source tree (directly fetched from x.org)

   ⚠️ Warning: this step will be executed in parallel (depending on your CPU count), it will take a few minutes to finish and will eat up all your CPUs.

   $ node setup

3. Launch Vite privew server

   $ npm run dev

4. Build for distribution

   $ npm run build