https://github.com/barisgit/kilm_docs

https://github.com/barisgit/kilm_docs

Last synced: 12 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/barisgit/kilm_docs
• Owner: barisgit
• Created: 2025-04-16T02:05:09.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-21T11:23:44.000Z (about 1 year ago)
• Last Synced: 2025-06-21T11:35:29.073Z (about 1 year ago)
• Language: MDX
• Homepage: https://kilm-docs.vercel.app
• Size: 283 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# KiLM Documentation

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

[![Documentation](https://img.shields.io/badge/docs-website-brightgreen.svg)](https://kilm.aristovnik.me)

This repository contains the documentation for [KiLM (KiCad Library Manager)](https://github.com/aharistovik/kilm), a command-line tool for managing KiCad libraries across projects and workstations.

## 📚 Documentation Structure

The documentation is organized into the following sections:

- **Guides**: Step-by-step tutorials and how-to guides

- **Reference**: Detailed command and API references

- **Community**: Information about contributing and development

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command                   | Action                                           |

| :------------------------ | :----------------------------------------------- |

| `pnpm install`            | Installs dependencies                            |

| `pnpm dev`                | Starts local dev server at `localhost:4321`      |

| `pnpm build`              | Build your production site to `./dist/`          |

| `pnpm preview`            | Preview your build locally, before deploying     |

## 🛠️ Project Structure

```

.

├── public/               # Static assets

├── src/

│   ├── assets/           # Images and other assets

│   ├── content/

│   │   ├── docs/         # Documentation content

│   │   │   ├── guides/   # User guides and tutorials

│   │   │   ├── reference/ # Command reference and API docs

│   │   │   └── community/ # Contributing guidelines

│   └── content.config.ts # Content collection config

├── astro.config.mjs      # Astro configuration

└── package.json

```

## 🔗 Links

- [KiLM Documentation Website](https://kilm.aristovnik.me)

- [Starlight Documentation](https://starlight.astro.build/)