open-index/open-npm huggingface dataset:
npm package: @scratch-dev/scratch
Description: A CLI for creating scratch writing projects
Author: Pete Koomen
Latest version: 0.1.2

# Scratch

Scratch is a simple tool for "vibe writing". It can be used with any editor to build static websites using MDX files and react components.

## Get Started

To get started, clone this repository and run 

```sh 
npm install 
npm run build

# add scratch cli to your PATH
npm link
```

### Creating a new scratch project

Now, try creating a new scratch writing project

```sh 
# create a new scratch project in myproj/
scratch create myproj
```
### Writing with scratch

Use your favorite AI code editor (e.g. [Windsurf](https://codeium.com/windsurf) or [neovim](https://neovim.io/) + [Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview)) to create and edit files in `myproj/website`. 

When you want a new component to help you communicate a concept, just ask your handy LLM assistant for help building it.

You can follow along locally by running the following command in your scratch project directory:

```sh 
npm run dev
```

### Publishing with scratch

When you're ready to publish, run the following command in your scratch project directory:

```sh 
npm run build
```

Scratch projects are compiled into static websites that can be hosted anywhere. You can find the compiled files in the `dist` folder inside of your scratch project directory.


## Examples

What can you create with scratch? Anything you can express in words and React components!

You can find a few examples on the [scratch website](https://scratch.dev)
npm package: @scratch-dev/scratch-dev
Description: A CLI for creating scratch writing projects
Author: Pete Koomen
Latest version: 0.1.1

# Scratch

Scratch is a simple tool for "vibe writing". It can be used with any editor to build static websites using MDX files and react components.

## Get Started

To get started, clone this repository and run 

```sh 
npm install 
npm run build

# add scratch cli to your PATH
npm link
```

### Creating a new scratch project

Now, try creating a new scratch writing project

```sh 
# create a new scratch project in myproj/
scratch create myproj
```
### Writing with scratch

Use your favorite AI code editor (e.g. [Windsurf](https://codeium.com/windsurf) or [neovim](https://neovim.io/) + [Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview)) to create and edit files in `myproj/website`. 

When you want a new component to help you communicate a concept, just ask your handy LLM assistant for help building it.

You can follow along locally by running the following command in your scratch project directory:

```sh 
npm run dev
```

### Publishing with scratch

When you're ready to publish, run the following command in your scratch project directory:

```sh 
npm run build
```

Scratch projects are compiled into static websites that can be hosted anywhere. You can find the compiled files in the `dist` folder inside of your scratch project directory.


## Examples

What can you create with scratch? Anything you can express in words and React components!

You can find a few examples on the [scratch website](https://scratch.dev)