Docoddity NPM | npm.io

0.4.19 • Published 9 months ago

Install

Weekly downloads

-

License

MIT

Repository

Last release

9 months ago

docoddity

A simple documentation static site generator that uses web components. Primarily intended for libraries.

Quickstart

In your library, create a docs folder:

mkdir docs

Create a package.json and install docoddity as a dependency:

{
  "name": "@my-library/docs",
  "private": true,
  "type": "module",
  "scripts": {
    "dev": "docoddity start --port 8080",
    "build": "docoddity build --output ./build",
    "serve": "pnpx serve ./build"
  },
  "devDependencies": {
    "docoddity": "latest"
  }
}

Add some content:

touch content/index.md

And run!

pnpm dev

@docsearch/js @shoelace-style/shoelace browser-sync chalk chokidar commander concurrently fs-extra glob js-yaml lit lit-html markdown-it markdown-it-anchor markdown-it-front-matter mustache nunjucks parser-front-matter ts-node

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago