{ "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": "
Repository for the documentation of the Dat Project ecosystem. View the docs at docs.datproject.org.
\n\nSee 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.
This documentation uses minidocs for layout, ecosystem-docs to get documentation from other modules, and ideas from pull-stream-docs for auto travis deployment.
\nnpm install
npm run build:local
to build the docs for local viewingnpm run update
to update external modulesnpm run start
to view the docs in browserThis repository uses netlify for deployment. Deployment will happen automatically.
\nIt works this way:
\nnpm install
sh scripts/netlify.sh
, which:ecosystem-docs
and pull latests readme filesnpm run netlify
which updates remote repos and builds./dist
to the webnpm update
: update external module readme filesnpm run build:local
: build app & css for local viewingnpm start
: start budo server to view locally