0.0.0 • Published 3 months ago

@simbashrd/docs v0.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
3 months ago

@simbashrd/docs

šŸ“– Documentation for simbashrd's Blog Projects

This repository contains the documentation for simbashrd's blog projects, built using Next.js and other modern tools.

šŸš€ Getting Started

Installation

First, make sure you have pnpm installed. Then, install dependencies:

pnpm install

Development

To start the local development server, run:

pnpm dev
This will start the Next.js app on http://localhost:3002.

Building the Project

To build the project for production:

pnpm build
If you need to generate MDX content
pnpm build:mdx
Linting & Type Checking

Run the linter to check for code style issues:

pnpm lint

To automatically fix linting errors:

pnpm lint:fix

To check for TypeScript errors:

pnpm type-check

šŸ“¦ Project Structure

.
ā”œā”€ā”€ public/            # Static assets
│   └── img/          # Images
ā”œā”€ā”€ src/              # Source code
│   ā”œā”€ā”€ components/   # Reusable UI components
│   ā”œā”€ā”€ templates/    # MDX templates
│   └── index.ts      # Entry point
ā”œā”€ā”€ package.json      # Project dependencies & scripts
ā”œā”€ā”€ tsconfig.json     # TypeScript configuration
└── eslint.config.mjs # ESLint configuration