{ "name": "datproject/docs", "version": "0.1.4", "libraries": { "xv": "^1.1.25" }, "title": "", "branch": "", "style": { "name": "Swiss", "componentSet": { "nav": "nav/BasicNav", "header": "header/SwissHeader", "article": "article/SwissArticle", "footer": "footer/BasicFooter" }, "fontFamily": "\"Helvetica Neue\", Helvetica, Arial, sans-serif", "heading": { "fontWeight": 700, "letterSpacing": "-0.01em" }, "layout": { "fluid": true }, "colors": { "text": "#000", "background": "#fff", "primary": "#05a", "secondary": "#444", "highlight": "#f30", "border": "#ccc", "muted": "#eee" } }, "content": [ { "component": "nav", "links": [ { "href": "http://docs.datproject.org/", "text": "Home" }, { "href": "https://github.com/datproject/docs", "text": "GitHub" }, { "href": "https://npmjs.com/package/dat-docs", "text": "npm" } ] }, { "component": "header", "heading": "docs", "subhead": "Documentation resources for dat and the surrounding ecosystem", "children": [ { "component": "ui/TweetButton", "text": "docs: Documentation resources for dat and the surrounding ecosystem", "url": "http://docs.datproject.org/" }, { "component": "ui/GithubButton", "user": "datproject", "repo": "docs" } ], "text": "v1.0.0" }, { "component": "article", "metadata": { "source": "github.readme" }, "html": "

Dat Project Documentation

\n

Repository for the documentation of the Dat Project ecosystem. View the docs at docs.datproject.org.

\n

\n\n

\n

Writing & Editing Docs

\n

See docs folder for information on editing and adding docs. Once you finish editing the docs, send a PR to the deploy branch to get the edits automatically deployed.

\n

Development

\n

This documentation uses minidocs for layout, ecosystem-docs to get documentation from other modules, and ideas from pull-stream-docs for auto travis deployment.

\n

Viewing Docs Locally

\n
    \n
  1. Clone Repository
  2. \n
  3. npm install
  4. \n
  5. npm run build:local to build the docs for local viewing
  6. \n
  7. npm run update to update external modules
  8. \n
  9. npm run start to view the docs in browser
  10. \n
\n

Deployment

\n

This repository uses netlify for deployment. Deployment will happen automatically.

\n

It works this way:

\n\n

NPM Commands

\n

Local Docs Preview:

\n\n

Other commands:

\n\n" }, { "component": "footer", "links": [ { "href": "https://github.com/datproject/docs", "text": "GitHub" }, { "href": "https://github.com/datproject", "text": "datproject" } ] } ] }