Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# build output
dist/
# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*


# environment variables
.env
.env.production

# macOS-specific files
.DS_Store
47 changes: 47 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# 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/barisgit/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/)
79 changes: 79 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
// @ts-check
import { defineConfig, passthroughImageService } from "astro/config";
import starlight from "@astrojs/starlight";

import tailwindcss from "@tailwindcss/vite";

// https://astro.build/config
export default defineConfig({
image: {
service: passthroughImageService(),
},

site: "https://kilm.aristovnik.me",

integrations: [
starlight({
title: "KiLM",
customCss: [
// Path to your custom CSS file (relative to src)
"./src/styles/global.css",
],
components: {
// Override the default Footer component with our custom one
Footer: "./src/components/Footer.astro",
},
social: [
{
icon: "github",
label: "GitHub",
href: "https://github.com/barisgit/kilm",
},
],
sidebar: [
{
label: "Guides",
items: [
{ label: "Getting Started", link: "/guides/getting-started/" },
{ label: "Installation", link: "/guides/installation/" },
{ label: "Configuration", link: "/guides/configuration/" },
{
label: "Custom Descriptions",
link: "/guides/custom-descriptions/",
},
{ label: "Automatic Updates", link: "/guides/automatic-updates/" },
{ label: "Troubleshooting", link: "/guides/troubleshooting/" },
],
},
{
label: "Command Reference",
items: [
{ label: "Overview", link: "/reference/cli/" }, // Optional: Add an overview page
{ label: "init", link: "/reference/cli/init/" },
{ label: "add-3d", link: "/reference/cli/add-3d/" },
{ label: "config", link: "/reference/cli/config/" },
{ label: "setup", link: "/reference/cli/setup/" },
{ label: "pin", link: "/reference/cli/pin/" },
{ label: "unpin", link: "/reference/cli/unpin/" },
{ label: "template", link: "/reference/cli/template/" },
{ label: "list", link: "/reference/cli/list/" },
{ label: "status", link: "/reference/cli/status/" },
{ label: "update", link: "/reference/cli/update/" },
{ label: "add-hook", link: "/reference/cli/add-hook/" },
],
},
{
label: "Community",
items: [
{ label: "Development Setup", link: "/community/development/" },
{ label: "Contributing", link: "/community/contributing/" },
{ label: "License", link: "/community/license/" },
],
},
],
}),
],
vite: {
plugins: [tailwindcss()],
},
});
23 changes: 23 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "kilm-docs",
"type": "module",
"version": "0.0.1",
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview",
"astro": "astro"
},
"dependencies": {
"@astrojs/starlight": "^0.33.2",
"@astrojs/starlight-tailwind": "^4.0.0",
"@tailwindcss/vite": "^4.1.4",
"astro": "^5.6.1",
"prettier": "^3.6.2",
"tailwindcss": "^4.1.4"
},
"devDependencies": {
"sharp": "^0.32.6"
}
}
Loading