An open API service indexing awesome lists of open source software.

https://github.com/becomevocal/nextra-with-partials


https://github.com/becomevocal/nextra-with-partials

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# Nextra

Simple, powerful and flexible site generation framework with everything you love from Next.js.

## Documentation

[https://nextra.site](https://nextra.site)

## Development

### Installation

The Nextra repository uses [PNPM Workspaces](https://pnpm.io/workspaces) and [Turborepo](https://github.com/vercel/turborepo). To install dependencies, just simply run `pnpm` in the project root directory.

### Build Nextra Core

```bash
cd packages/nextra
pnpm build
```

Watch mode: `pnpm dev`

### Build Nextra Theme

```bash
cd packages/nextra-theme-docs
pnpm build
```

| Command | Description |
| ----------------- | ------------------------ |
| pnpm dev | Watch mode |
| pnpm dev:layout | Watch mode (layout only) |
| pnpm dev:tailwind | Watch mode (style only) |

### Development

You can also debug them together with a website locally. For instance, to start examples/docs locally, run

```bash
cd examples/docs
pnpm dev
```

Any change to example/docs will be re-rendered instantly.

If you update the core or theme packages, a rebuild is required. Or you can use the watch mode for both nextra and the theme in separated terminals.