diff --git a/.circleci/config.yml b/.circleci/config.yml index af77503c..db7535ce 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,13 +1,15 @@ --- version: 2.1 executors: - doc_executor: + python_executor: docker: - image: circleci/python:3.7.4 - + node_executor: + docker: + - image: circleci/node:12.9.0-stretch jobs: build: - executor: doc_executor + executor: python_executor steps: - checkout - restore_cache: @@ -28,15 +30,9 @@ jobs: command: | . venv/bin/activate mkdocs build -s - - persist_to_workspace: - root: /home/circleci/project - paths: site - - store_artifacts: - path: ./site - destination: site vale: - executor: doc_executor + executor: python_executor steps: - checkout - setup_remote_docker @@ -53,26 +49,36 @@ jobs: destination: vale.out linkchecker: - executor: doc_executor + executor: node_executor steps: - checkout - - setup_remote_docker - - attach_workspace: - at: /home/circleci/project - run: - name: Run LinkChecker + name: update-npm + command: 'sudo npm install -g npm@latest' + - restore_cache: + keys: + - deps-{{ checksum "package.json" }} + - run: + # copy files into this volume + name: Install dependencies command: | - # create a dummy container which will hold a volume with data - docker create -v /doc --name docVol alpine:3.4 /bin/true - # copy files into this volume - docker cp ./ docVol:/doc - docker run --rm -u $(id -u):$(id -g) --volumes-from docVol linkchecker/linkchecker /doc/site/ --ignore-url='custom_theme' --ignore-url='404.html' --ignore-url='http://localhost' --ignore-url='https://localhost' --check-extern --no-status > linkchecker.out + npm install + - run: + # copy files into this volume + name: Run markdown link checker + command: | + find . -name \*.md ! -path "./node_modules/*" -exec ./node_modules/markdown-link-check/markdown-link-check -q -c link_check_conf.json {} \; > linkchecker.out 2>&1 + ! grep "ERROR:" ./linkchecker.out + - save_cache: + paths: + - ./node_modules + key: deps-{{ checksum "package.json" }} - store_artifacts: path: ./linkchecker.out destination: linkchecker.out markdownlint: - executor: doc_executor + executor: python_executor steps: - checkout - setup_remote_docker @@ -95,6 +101,4 @@ workflows: - build - vale - markdownlint - - linkchecker: - requires: - - build + - linkchecker diff --git a/.gitignore b/.gitignore index 8eece155..0aa60d24 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ site/ env/ *.out +node_modules/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8eddabab..69b9dc79 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -217,6 +217,6 @@ in this guide. [private@pegasys.tech]: mailto:private@pegasys.tech [Gitter]: https://gitter.im/PegaSysEng/pantheon [Pantheon documentation]: https://docs.pantheon.pegasys.tech/ -[CLA.md]: /CLA.md -[Code Reviews]: /docs/community/code-reviews.md +[CLA.md]: ./CLA.md +[Code Reviews]: ./docs/community/code-reviews.md [MkDocs]: https://www.mkdocs.org/ \ No newline at end of file diff --git a/DOC-STYLE-GUIDE.md b/DOC-STYLE-GUIDE.md index 3c131b56..b3eaabfc 100644 --- a/DOC-STYLE-GUIDE.md +++ b/DOC-STYLE-GUIDE.md @@ -42,7 +42,7 @@ This doesn't mean explaining all Ethereum concepts in our documentation. Explain and when an understanding of complex Ethereum concepts is required refer users to relevant resources. For example, to explain how the EVM works, link to ethdocs.org documentation such as -http://ethdocs.org/en/latest/introduction/what-is-ethereum.html#ethereum-virtual-machine +https://github.com/ethereum/wiki/wiki/Ethereum-Virtual-Machine-(EVM)-Awesome-List Simple explanations must still be technically correct. diff --git a/GOVERNANCE.md b/GOVERNANCE.md index e28387da..90458324 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -35,9 +35,9 @@ This document was influenced by the following: - Kubernetes governance.md, available at [kub governance] - OSSWatch Benevolent Dictator Governance Model, available at [oss watch benevolent dictator]. -[CLA.md]: /CLA.md -[community membership]: /docs/community/community-membership.md -[code of conduct]: /CODE-OF-CONDUCT.md +[CLA.md]: ./CLA.md +[community membership]: ./docs/community/community-membership.md +[code of conduct]: ./CODE-OF-CONDUCT.md [oss watch benevolent dictator]: http://oss-watch.ac.uk/resources/benevolentdictatorgovernancemodel [kub community membership]: https://raw.githubusercontent.com/kubernetes/community/master/community-membership.md [kub governance]:https://github.com/kubernetes/community/blob/master/governance.md diff --git a/MKDOCS-MARKDOWN-GUIDE.md b/MKDOCS-MARKDOWN-GUIDE.md index fb49a610..4b9e6114 100644 --- a/MKDOCS-MARKDOWN-GUIDE.md +++ b/MKDOCS-MARKDOWN-GUIDE.md @@ -4,7 +4,7 @@ Pantheon documentation is written using [Markdown](https://daringfireball.net/pr However, we use two flavors of this syntax: -- One for pages inside the [/docs](/docs) directory that will be rendered by [MkDocs] as described below +- One for pages inside the [/docs] directory that will be rendered by [MkDocs] as described below in the [Installed Markdown Extensions](#installed-markdown-extensions) section. - Another using the [Github syntax](https://guides.github.com/features/mastering-markdown/) for pages outside of this documentation directory. These are mainly files to support our [open source @@ -13,11 +13,11 @@ community](https://github.com/PegaSysEng/pantheon/community). ## MkDocs Documentation Website The [Pantheon documentation website](https://docs.pantheon.pegasys.tech/) is maintained by PegaSys from -the content of the [/docs](/docs) directory. +the content of the [/docs] directory. ### /docs Directory -The [/docs](/docs) directory in the Pantheon documentation repository contains all the documentation that +The [/docs] directory in the Pantheon documentation repository contains all the documentation that is generated into a static HTML website using [MkDocs] and the [Mkdocs Material] theme and hosted by [readthedocs.org]. The documentation is automatically updated using [WebHooks](https://docs.readthedocs.io/en/stable/webhooks.html) @@ -35,7 +35,7 @@ If any issues occur, contact the maintainers of the [Pantheon documentation proj Our [MkDocs] setup uses a [Mkdocs Material] theme to render the html pages. It also comes with a number of useful extensions. -[MkDocs] in configured in the [mdkocs.yml](/mkdocs.yml) file. +[MkDocs] in configured in the [mdkocs.yml](./mkdocs.yml) file. This file configures: @@ -110,7 +110,7 @@ You can quickly achieve this by using a tool like http://markdowntable.com/ ## Installed Markdown Extensions >**Important** -> Extensions are only available for the docs under [/docs](/docs) directory. +> Extensions are only available for the docs under [/docs] directory. As markdown can be a bit limited when it comes to some specific rendering of code, TOCs, and other documentation elements, we configured some extensions for these items. @@ -136,7 +136,7 @@ If you have content to be repeated on multiple pages, you can create it in a com it in all required pages. Example: -To include the content of the "test_accounts.md" page in the "/docs/global" directory in another page, use: +To include the content of the "test_accounts.md" page in the "[/docs/global](./docs/global)" directory in another page, use: ```markdown {!global/test_accounts.md!} ``` @@ -417,6 +417,7 @@ Pygment is the implementation for this extension, refer to Pygment website for a +[/docs]: ./docs [MkDocs]: https://www.mkdocs.org/ [readthedocs.org]: https://readthedocs.org/ [Mkdocs Material]: https://squidfunk.github.io/mkdocs-material/ diff --git a/docs/HowTo/Interact/Pantheon-APIs/GraphQL.md b/docs/HowTo/Interact/Pantheon-APIs/GraphQL.md index 410481dc..9ab189a0 100644 --- a/docs/HowTo/Interact/Pantheon-APIs/GraphQL.md +++ b/docs/HowTo/Interact/Pantheon-APIs/GraphQL.md @@ -7,7 +7,7 @@ GraphQL can reduce the overhead needed for common queries. For example, instead block, GraphQL can obtain the same result with a single query for the entire block. The GraphQL implementation for Ethereum is described in the [schema](https://github.com/PegaSysEng/pantheon/blob/master/ethereum/graphql/src/main/resources/schema.graphqls). -The GraphQL service is enabled using the [command line options](../../../Pantheon-API#enabling-api-access). +The GraphQL service is enabled using the [command line options](Pantheon-API.md#enabling-api-access). !!! note GraphQL is not supported over WebSockets. diff --git a/docs/community/code-reviews.md b/docs/community/code-reviews.md index 709cbb4d..6c406668 100644 --- a/docs/community/code-reviews.md +++ b/docs/community/code-reviews.md @@ -22,5 +22,5 @@ If a PR has gone 2 work days without an approver emerging, please ask on [Panthe This Document was adapted by the following: - Kubernetes collab.md, available at [kub collab] -[kub collab]: https://raw.githubusercontent.com/kubernetes/community/master/contributors/devel/collab.md +[kub collab]: https://raw.githubusercontent.com/kubernetes/community/master/contributors/guide/collab.md [Pantheon Gitter]: https://gitter.im/PegaSysEng/pantheon \ No newline at end of file diff --git a/docs/community/community-membership.md b/docs/community/community-membership.md index f7f5b061..60d2ba03 100644 --- a/docs/community/community-membership.md +++ b/docs/community/community-membership.md @@ -163,12 +163,12 @@ This document is adapted from the following sources: - Kubernetes community-membership.md, available at [kub community membership]. - OSSWatch Benevolent Dictator Governance Model, available at [oss watch benevolent dictator]. -[CLA.md]: /CLA.md +[CLA.md]: ../../CLA.md [oss watch benevolent dictator]: http://oss-watch.ac.uk/resources/benevolentdictatorgovernancemodel [kub community membership]: https://raw.githubusercontent.com/kubernetes/community/master/community-membership.md -[code reviews]: /docs/community/code-reviews.md -[contributor guide]: /CONTRIBUTING.md -[New contributors]: /CONTRIBUTING.md +[code reviews]: ./code-reviews.md +[contributor guide]: ../../CONTRIBUTING.md +[New contributors]: ../../CONTRIBUTING.md [two-factor authentication]: https://help.github.com/articles/about-two-factor-authentication [pantheon-dev@pegasys.tech]: mailto:pantheon-dev@pegasys.tech [Pantheon Gitter]: https://gitter.im/PegaSysEng/pantheon diff --git a/link_check_conf.json b/link_check_conf.json new file mode 100644 index 00000000..ad74213c --- /dev/null +++ b/link_check_conf.json @@ -0,0 +1,19 @@ +{ + "ignorePatterns": [ + { + "pattern": "^http(s)?://localhost" + }, + { + "pattern": "^http(s)?://127.0.0.1" + }, + { + "pattern": "^http(s)?://github.com/PegaSysEng/pantheon/community" + }, + { + "pattern": "^http(s)?://ropsten.etherscan.io/txs\\?block=" + }, + { + "pattern": "^http(s)?://ropsten.etherscan.io/tx/0x" + } + ] +} diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 00000000..d68da4c8 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,483 @@ +{ + "name": "doc.pantheon", + "version": "1.0.0", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "ajv": { + "version": "6.10.2", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.10.2.tgz", + "integrity": "sha512-TXtUUEYHuaTEbLZWIKUr5pmBuhDLy+8KYtPYdcV8qC+pOZL+NKqYwvWSRrVXHn+ZmRRAu8vJTAznH7Oag6RVRw==", + "requires": { + "fast-deep-equal": "^2.0.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + } + }, + "ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "requires": { + "color-convert": "^1.9.0" + } + }, + "asn1": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.4.tgz", + "integrity": "sha512-jxwzQpLQjSmWXgwaCZE9Nz+glAG01yF1QnWgbhGwHI5A6FRIEY6IVqtHhIepHqI7/kyEyQEagBC5mBEFlIYvdg==", + "requires": { + "safer-buffer": "~2.1.0" + } + }, + "assert-plus": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", + "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=" + }, + "async": { + "version": "2.6.3", + "resolved": "https://registry.npmjs.org/async/-/async-2.6.3.tgz", + "integrity": "sha512-zflvls11DCy+dQWzTW2dzuilv8Z5X/pjfmZOWba6TNIVDm+2UDaJmXSOXlasHKfNBs8oo3M0aT50fDEWfKZjXg==", + "requires": { + "lodash": "^4.17.14" + } + }, + "asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=" + }, + "aws-sign2": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", + "integrity": "sha1-tG6JCTSpWR8tL2+G1+ap8bP+dqg=" + }, + "aws4": { + "version": "1.8.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.8.0.tgz", + "integrity": "sha512-ReZxvNHIOv88FlT7rxcXIIC0fPt4KZqZbOlivyWtXLt8ESx84zd3kMC6iK5jVeS2qt+g7ftS7ye4fi06X5rtRQ==" + }, + "bcrypt-pbkdf": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", + "integrity": "sha1-pDAdOJtqQ/m2f/PKEaP2Y342Dp4=", + "requires": { + "tweetnacl": "^0.14.3" + } + }, + "caseless": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", + "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=" + }, + "chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "requires": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + } + }, + "color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "requires": { + "color-name": "1.1.3" + } + }, + "color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=" + }, + "combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "requires": { + "delayed-stream": "~1.0.0" + } + }, + "commander": { + "version": "2.20.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.0.tgz", + "integrity": "sha512-7j2y+40w61zy6YC2iRNpUe/NwhNyoXrYpHMrSunaMG64nRnaf96zO/KMQR4OyN/UnE5KLyEBnKHd4aG3rskjpQ==" + }, + "core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=" + }, + "dashdash": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", + "integrity": "sha1-hTz6D3y+L+1d4gMmuN1YEDX24vA=", + "requires": { + "assert-plus": "^1.0.0" + } + }, + "delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=" + }, + "ecc-jsbn": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", + "integrity": "sha1-OoOpBOVDUyh4dMVkt1SThoSamMk=", + "requires": { + "jsbn": "~0.1.0", + "safer-buffer": "^2.1.0" + } + }, + "escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=" + }, + "extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==" + }, + "extsprintf": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", + "integrity": "sha1-lpGEQOMEGnpBT4xS48V06zw+HgU=" + }, + "fast-deep-equal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz", + "integrity": "sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk=" + }, + "fast-json-stable-stringify": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz", + "integrity": "sha1-1RQsDK7msRifh9OnYREGT4bIu/I=" + }, + "forever-agent": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", + "integrity": "sha1-+8cfDEGt6zf5bFd60e1C2P2sypE=" + }, + "form-data": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.3.3.tgz", + "integrity": "sha512-1lLKB2Mu3aGP1Q/2eCOx0fNbRMe7XdwktwOruhfqqd0rIJWwN4Dh+E3hrPSlDCXnSR7UtZ1N38rVXm+6+MEhJQ==", + "requires": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.6", + "mime-types": "^2.1.12" + } + }, + "getpass": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", + "integrity": "sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo=", + "requires": { + "assert-plus": "^1.0.0" + } + }, + "har-schema": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", + "integrity": "sha1-qUwiJOvKwEeCoNkDVSHyRzW37JI=" + }, + "har-validator": { + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-5.1.3.tgz", + "integrity": "sha512-sNvOCzEQNr/qrvJgc3UG/kD4QtlHycrzwS+6mfTrrSq97BvaYcPZZI1ZSqGSPR73Cxn4LKTD4PttRwfU7jWq5g==", + "requires": { + "ajv": "^6.5.5", + "har-schema": "^2.0.0" + } + }, + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=" + }, + "http-signature": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz", + "integrity": "sha1-muzZJRFHcvPZW2WmCruPfBj7rOE=", + "requires": { + "assert-plus": "^1.0.0", + "jsprim": "^1.2.2", + "sshpk": "^1.7.0" + } + }, + "is-absolute-url": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-absolute-url/-/is-absolute-url-2.1.0.tgz", + "integrity": "sha1-UFMN+4T8yap9vnhS6Do3uTufKqY=" + }, + "is-relative-url": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-relative-url/-/is-relative-url-2.0.0.tgz", + "integrity": "sha1-cpAtf+BLPUeS59sV+duEtyBMnO8=", + "requires": { + "is-absolute-url": "^2.0.0" + } + }, + "is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha1-5HnICFjfDBsR3dppQPlgEfzaSpo=" + }, + "isemail": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/isemail/-/isemail-3.2.0.tgz", + "integrity": "sha512-zKqkK+O+dGqevc93KNsbZ/TqTUFd46MwWjYOoMrjIMZ51eU7DtQG3Wmd9SQQT7i7RVnuTPEiYEWHU3MSbxC1Tg==", + "requires": { + "punycode": "2.x.x" + } + }, + "isstream": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz", + "integrity": "sha1-R+Y/evVa+m+S4VAOaQ64uFKcCZo=" + }, + "jsbn": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz", + "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=" + }, + "json-schema": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz", + "integrity": "sha1-tIDIkuWaLwWVTOcnvT8qTogvnhM=" + }, + "json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + }, + "json-stringify-safe": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", + "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus=" + }, + "jsprim": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz", + "integrity": "sha1-MT5mvB5cwG5Di8G3SZwuXFastqI=", + "requires": { + "assert-plus": "1.0.0", + "extsprintf": "1.3.0", + "json-schema": "0.2.3", + "verror": "1.10.0" + } + }, + "link-check": { + "version": "4.4.5", + "resolved": "https://registry.npmjs.org/link-check/-/link-check-4.4.5.tgz", + "integrity": "sha512-csF0k7MAQjyDLkrZfsAJNkTav/vvATMYkm9dAstzmu60vzNGlgvWd3SgBTFH9KLWOO1hUuVxgSEPuWv+fdyuaQ==", + "requires": { + "is-relative-url": "^2.0.0", + "isemail": "^3.2.0", + "ms": "^2.1.1", + "request": "^2.88.0" + } + }, + "lodash": { + "version": "4.17.15", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz", + "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==" + }, + "markdown-link-check": { + "version": "3.7.3", + "resolved": "https://registry.npmjs.org/markdown-link-check/-/markdown-link-check-3.7.3.tgz", + "integrity": "sha512-X/HWomzeox5HtkKLupin4affBXHq22r7RNqiSKsxlgZQMSU9n+zpGY0sbzJr1IycB6FXpKUZet1VH3Rs1/8WQg==", + "requires": { + "async": "^2.6.1", + "chalk": "^2.4.2", + "commander": "^2.20.0", + "link-check": "^4.4.5", + "lodash": "^4.17.11", + "markdown-link-extractor": "^1.2.1", + "progress": "^2.0.3", + "request": "^2.88.0" + } + }, + "markdown-link-extractor": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/markdown-link-extractor/-/markdown-link-extractor-1.2.1.tgz", + "integrity": "sha512-eo4hXLZC6/NrVimHqEu0X029ymIreg0VQjlWudGtOg1FiiZYPwU+Sh1CP3CQqP16woyCsDplVfqPD2Oi8JRpdw==", + "requires": { + "marked": "^0.6.2" + } + }, + "marked": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/marked/-/marked-0.6.3.tgz", + "integrity": "sha512-Fqa7eq+UaxfMriqzYLayfqAE40WN03jf+zHjT18/uXNuzjq3TY0XTbrAoPeqSJrAmPz11VuUA+kBPYOhHt9oOQ==" + }, + "mime-db": { + "version": "1.40.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.40.0.tgz", + "integrity": "sha512-jYdeOMPy9vnxEqFRRo6ZvTZ8d9oPb+k18PKoYNYUe2stVEBPPwsln/qWzdbmaIvnhZ9v2P+CuecK+fpUfsV2mA==" + }, + "mime-types": { + "version": "2.1.24", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.24.tgz", + "integrity": "sha512-WaFHS3MCl5fapm3oLxU4eYDw77IQM2ACcxQ9RIxfaC3ooc6PFuBMGZZsYpvoXS5D5QTWPieo1jjLdAm3TBP3cQ==", + "requires": { + "mime-db": "1.40.0" + } + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==" + }, + "oauth-sign": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz", + "integrity": "sha512-fexhUFFPTGV8ybAtSIGbV6gOkSv8UtRbDBnAyLQw4QPKkgNlsH2ByPGtMUqdWkos6YCRmAqViwgZrJc/mRDzZQ==" + }, + "performance-now": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", + "integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns=" + }, + "progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==" + }, + "psl": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/psl/-/psl-1.3.0.tgz", + "integrity": "sha512-avHdspHO+9rQTLbv1RO+MPYeP/SzsCoxofjVnHanETfQhTJrmB0HlDoW+EiN/R+C0BZ+gERab9NY0lPN2TxNag==" + }, + "punycode": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==" + }, + "qs": { + "version": "6.5.2", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz", + "integrity": "sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA==" + }, + "request": { + "version": "2.88.0", + "resolved": "https://registry.npmjs.org/request/-/request-2.88.0.tgz", + "integrity": "sha512-NAqBSrijGLZdM0WZNsInLJpkJokL72XYjUpnB0iwsRgxh7dB6COrHnTBNwN0E+lHDAJzu7kLAkDeY08z2/A0hg==", + "requires": { + "aws-sign2": "~0.7.0", + "aws4": "^1.8.0", + "caseless": "~0.12.0", + "combined-stream": "~1.0.6", + "extend": "~3.0.2", + "forever-agent": "~0.6.1", + "form-data": "~2.3.2", + "har-validator": "~5.1.0", + "http-signature": "~1.2.0", + "is-typedarray": "~1.0.0", + "isstream": "~0.1.2", + "json-stringify-safe": "~5.0.1", + "mime-types": "~2.1.19", + "oauth-sign": "~0.9.0", + "performance-now": "^2.1.0", + "qs": "~6.5.2", + "safe-buffer": "^5.1.2", + "tough-cookie": "~2.4.3", + "tunnel-agent": "^0.6.0", + "uuid": "^3.3.2" + } + }, + "safe-buffer": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.0.tgz", + "integrity": "sha512-fZEwUGbVl7kouZs1jCdMLdt95hdIv0ZeHg6L7qPeciMZhZ+/gdesW4wgTARkrFWEpspjEATAzUGPG8N2jJiwbg==" + }, + "safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" + }, + "sshpk": { + "version": "1.16.1", + "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.16.1.tgz", + "integrity": "sha512-HXXqVUq7+pcKeLqqZj6mHFUMvXtOJt1uoUx09pFW6011inTMxqI8BA8PM95myrIyyKwdnzjdFjLiE6KBPVtJIg==", + "requires": { + "asn1": "~0.2.3", + "assert-plus": "^1.0.0", + "bcrypt-pbkdf": "^1.0.0", + "dashdash": "^1.12.0", + "ecc-jsbn": "~0.1.1", + "getpass": "^0.1.1", + "jsbn": "~0.1.0", + "safer-buffer": "^2.0.2", + "tweetnacl": "~0.14.0" + } + }, + "supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "requires": { + "has-flag": "^3.0.0" + } + }, + "tough-cookie": { + "version": "2.4.3", + "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.4.3.tgz", + "integrity": "sha512-Q5srk/4vDM54WJsJio3XNn6K2sCG+CQ8G5Wz6bZhRZoAe/+TxjWB/GlFAnYEbkYVlON9FMk/fE3h2RLpPXo4lQ==", + "requires": { + "psl": "^1.1.24", + "punycode": "^1.4.1" + }, + "dependencies": { + "punycode": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-1.4.1.tgz", + "integrity": "sha1-wNWmOycYgArY4esPpSachN1BhF4=" + } + } + }, + "tunnel-agent": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", + "integrity": "sha1-J6XeoGs2sEoKmWZ3SykIaPD8QP0=", + "requires": { + "safe-buffer": "^5.0.1" + } + }, + "tweetnacl": { + "version": "0.14.5", + "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", + "integrity": "sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=" + }, + "uri-js": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.2.2.tgz", + "integrity": "sha512-KY9Frmirql91X2Qgjry0Wd4Y+YTdrdZheS8TFwvkbLWf/G5KNJDCh6pKL5OZctEW4+0Baa5idK2ZQuELRwPznQ==", + "requires": { + "punycode": "^2.1.0" + } + }, + "uuid": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.3.3.tgz", + "integrity": "sha512-pW0No1RGHgzlpHJO1nsVrHKpOEIxkGg1xB+v0ZmdNH5OAeAwzAVrCnI2/6Mtx+Uys6iaylxa+D3g4j63IKKjSQ==" + }, + "verror": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz", + "integrity": "sha1-OhBcoXBTr1XW4nDB+CiGguGNpAA=", + "requires": { + "assert-plus": "^1.0.0", + "core-util-is": "1.0.2", + "extsprintf": "^1.2.0" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 00000000..c72c3de3 --- /dev/null +++ b/package.json @@ -0,0 +1,25 @@ +{ + "name": "doc.pantheon", + "version": "1.0.0", + "description": "Pantheon doc site", + "main": "index.js", + "directories": { + "doc": "docs" + }, + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/PegaSysEng/doc.pantheon.git" + }, + "author": "Consensys/Pegasys", + "license": "Apache-2.0", + "bugs": { + "url": "https://github.com/PegaSysEng/doc.pantheon/issues" + }, + "homepage": "https://github.com/PegaSysEng/doc.pantheon#readme", + "dependencies": { + "markdown-link-check": "3.7.3" + } +}