Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/pangolinjs/docs

Documentation for Pangolin.js.
https://github.com/pangolinjs/docs

documentation pangolinjs wiki

Last synced: 13 days ago
JSON representation

Documentation for Pangolin.js.

Awesome Lists containing this project

README

        

# Pangolin.js Docs

Documentation for [Pangolin.js](https://pangolinjs.org).

Requires [Node.js 16+](https://nodejs.org).

## Installation

Install npm dependencies.

```bash
npm install
```

Update dependencies.

```bash
# Check for available updates.
npm outdated

# Install updates.
npm update
```

## Development

Start development server with hot reloading.

```bash
npm run dev
```

## Production

Build static site files. Outputs to `docs/.vitepress/dist`.

```bash
npm run build
```

## Linting

```bash
# Run JS files through ESLint.
npm run lint:js

# Check for consistent Markdown formatting.
npm run lint:markdown

# Check for inclusive language with Alex.
npm run lint:language
```