aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: fdc011c7c3dceaa3bbcc9e99fadb6110705cbba3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
## Dat Project Documentation

Repository for the documentation of the Dat Project ecosystem. View the docs at [docs.dat-data.com](http://docs.dat-data.com).

[![#dat IRC channel on freenode](https://img.shields.io/badge/irc%20channel-%23dat%20on%20freenode-blue.svg)](http://webchat.freenode.net/?channels=dat)
[![datproject/discussions](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/datproject/discussions?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![docs](https://img.shields.io/badge/Dat%20Project-Docs-green.svg)](http://docs.dat-data.com)

## Writing & Editing Docs

This documentation uses [minidocs](https://www.npmjs.com/package/minidocs).

The table of contents is in `content.json`.

### Installation & Usage

1. Clone Repository
2. `npm install`
3. `npm run build` to build the docs.
4. `npm run deploy` to deploy docs to GitHub pages.

## License

ISC