Getting Started

NekoDoc is a tools for creating/development static website.
If you are famililar with Node.js and React, you can easy to use NekoDoc!

Requirements

NekoDoc is running on Node.js greater than 16.x and ESM environment.
If you are not installed it, install it at the first.

Installation

NekoDoc is published to a NPM (and Yarn) registry, and can installed with yarn or npm command.

$ yarn add nekodoc

Creating your website

After installation, you can bootstrap NekoDoc project using nekodoc command.

$ yarn run nekodoc init

This command will create below file(s) into your current directory.

• tailwind.config.js

tailwind.config.js is configuration file for TailwindCSS.
After the creation configuration file(s), create index.mdx into contents directory and run nekodoc start, you can preview your website at http://localhost:7225.