# doxicity

**Repository Path**: mirrors_claviska/doxicity

## Basic Information

- **Project Name**: doxicity
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: next
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-11
- **Last Updated**: 2026-07-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Doxicity 📗

Doxicity is a static site generator that turns markdown files into an HTML website. You can configure it, add data, layouts, partials, plugins, and use Handlebars `{{expressions}}` to do amazing things.

Designed in New Hampshire by [Cory LaViska](https://twitter.com/claviska).

---

## Installation

To install Doxicity, run the following command. This assumes you have [Node.js](https://nodejs.org/) installed.

```sh
npm i doxicity
```

## Usage

Here's a quick example to get you started with Doxicity.

```ts
import Doxicity from 'doxicity';

const __dirname = new URL('.', import.meta.url).pathname;

// Configure it
const dox = new Doxicity({
  source: Doxicity.resolve(__dirname),
  destination: Doxicity.resolve(__dirname, '_site'),
  baseUrl: 'https://example.com/'
  // more options here...
});

// Publish it
dox
  .publish()
  .then(result => {
    console.log(
      `Pages published: ${result.pages.length}\n` +
        `Assets copied: ${result.assets.length}\n` +
        `Duration: ${result.timeToPublish}ms\n`
    );
  })
  .catch(err => {
    console.clear();
    console.log(err.message);
  });
```

For more details, [please see the documentation](https://doxicity.com/).