Skip to content

douyixuan/switchatlas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

title mode
Home
wide

Welcome to SwitchAtlas

A comprehensive, visualized database of mechanical keyboard switches.

Explore smooth linear switches The classic standard Affordable custom switches High performance switches

About

This database collects specifications, force curves, and images for thousands of mechanical switches.

Data Sources

The data in SwitchAtlas is aggregated from multiple sources to provide the most comprehensive database possible:

  • ThereminGoat's Force Curves: A significant portion of the force curve data and basic specifications are imported from ThereminGoat's Repository. We attribute all force curve data to their original authors.
  • Manual Curation: High-quality specifications and images are manually curated by the community.

Project Structure

The project uses a file-system based database approach for easy maintenance and contribution.

.
├── data/
│   ├── vendors/         # Popular vendors (Shown in navigation)
│   │   ├── Cherry/
│   │   ├── Gateron/
│   │   └── ...
│   └── other_vendors/   # Archive of other vendors
├── mint.json            # Mintlify configuration (Navigation logic)
└── scripts/             # Maintenance scripts (Import, Migration, Config Gen)

Development

This project is built using Mintlify.

Prerequisites

  • Node.js installed
  • Mintlify CLI: npm i -g mintlify

Running Locally

To preview the documentation site locally:

mintlify dev

Automation Scripts

  • scripts/generate_mint_config.js: Regenerates mint.json based on the directories in data/vendors. Run this after adding new popular vendors.
  • scripts/reorganize_vendors.js: Utility to move non-popular vendors to the other_vendors directory.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •