# phd

> PHD is a static site generator with pluggable dynamic components

Latest version **1.0.10** (published 2017-09-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install phd
pnpm add phd
yarn add phd
bun add phd
```

Provides the command `phd`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.10 |
| Published | 2017-09-11 |
| First published | 2017-07-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | intercellular |

## Links

- npm: https://www.npmjs.com/package/phd
- npm.io page: https://npm.io/package/phd

## Dependencies (3)

- [jsdom](https://npm.io/package/jsdom.md) ^11.1.0
- [marked](https://npm.io/package/marked.md) ^0.3.6
- [intercellular](https://npm.io/package/intercellular.md) ^1.0.0

## Recent versions

- 1.0.10 (latest) — 2017-09-11
- 1.0.9 — 2017-09-11
- 1.0.8 — 2017-09-11
- 1.0.7 — 2017-09-11
- 1.0.6 — 2017-09-11
- 1.0.5 — 2017-09-09
- 1.0.4 — 2017-07-11
- 1.0.3 — 2017-07-11
- 1.0.2 — 2017-07-11
- 1.0.1 — 2017-07-11
- 1.0.0 — 2017-07-11

## README

<div class='logo'>
  <img src='./website/phd.png'>
  <h1>PHD</h1>
  <div>dynamic static site generator</div>
</div>

---

<div id='chimp'></div>

## What is PHD?

Automatically generate a static site from your repo's README.md and make it dynamic.

---

## Install

```
npm install --save-dev phd
```

---

## Usage

### Step 1. Create phd.config.js
Create a `phd.config.js` JS file to define a phd config object.

```
module.exports = [{
  input: ["README.md"],
  output: "index.html",
  js: ["https://www.celljs.org/cell.js"],
  css: [
    "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.0.0-alpha.6/css/bootstrap.min.css",
    "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.11.0/styles/grayscale.min.css",
    "https://fonts.googleapis.com/css?family=Raleway:300,400,500,600,700",
    "https://fonts.googleapis.com/css?family=Merriweather:900",
    "./website/style.css"
  ],
  init: function() {
    /**
     * Do whatever JS initialization you need
     */
  }
}]
```

<br>

### Step 2. Run

```
node phd
```

---

## Syntax


```
module.exports = {
  input: Array,
  output: String,
  js: Array,
  css: Array,
  init: Function
}
```

| attribute | description |
|-----------|-------------|
| input        | an array of markdown file paths in the current repository |
| output    | a string of output filename |
| js        | an array of JavaScript URLs |
| css       | an array of CSS URLs |
| init      | an initializier function that will run `onload` |

---

## Customization

TBD

---
_Source: https://npm.io/package/phd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._