diff --git a/README.md b/README.md index 39461ee670b..0997fc75348 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ -This is a trial project to explore new ways of hosting the Chainlink documentation. +This is the open source project for the Chainlink documentation. ## Developing yarn serve ## Building & Deploying -The site is hosted on firebase today on the free tier. This will likely move, but the files are super portable. Builds end up in `_site`. +The site is hosted on a static site CDN. The files are super portable. Builds end up in `_site`. yarn deploy +Make sure you use `yarn` and have a recent version of `node` (see the `package.json` for specific version requirements). ## Docs architecture * All docs are markdown and stored in `/docs`. -* Navigation is JSON in `/_data` +* Navigation is JSON in `/_data/navigation` * Pages are processed as Readme.com markdown, and then syntax highlight is applied client-side * Custom client side code powers the ENS page diff --git a/package.json b/package.json index f68a32c71c2..a3dc923b9de 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "chainlink-docs", "version": "1.0.0", "description": "", - "main": "index.js", + "private": true, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "serve": "npx @11ty/eleventy --serve --port=4200", @@ -24,10 +24,15 @@ "date-fns": "^2.21.1", "eleventy-plugin-youtube-embed": "^1.6.2", "firebase-tools": "^9.8.0", - "react": "^17.0.2", + "react": "^16.0.0", + "react-dom": "^16.14.0", "ts-node": "^9.1.1", "typescript": "^4.2.4" }, + "engines": { + "node": ">=14" + }, + "engineStrict": true, "prettier": { "semi": true, "trailingComma": "es5", diff --git a/yarn.lock b/yarn.lock index 96bd0ae65b4..c7528463da8 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4839,7 +4839,7 @@ promise@^7.0.1: dependencies: asap "~2.0.3" -prop-types@^15.7.2: +prop-types@^15.6.2, prop-types@^15.7.2: version "15.7.2" resolved "https://registry.yarnpkg.com/prop-types/-/prop-types-15.7.2.tgz#52c41e75b8c87e72b9d9360e0206b99dcbffa6c5" integrity sha512-8QQikdH7//R2vurIJSutZ1smHYTcLpRWEOlHnzcWHmBYrOGUysKwSsrC89BCiFj3CbrfJ/nXFdJepOVrY1GCHQ== @@ -5127,18 +5127,29 @@ react-codemirror2@^7.2.1: resolved "https://registry.yarnpkg.com/react-codemirror2/-/react-codemirror2-7.2.1.tgz#38dab492fcbe5fb8ebf5630e5bb7922db8d3a10c" integrity sha512-t7YFmz1AXdlImgHXA9Ja0T6AWuopilub24jRaQdPVbzUJVNKIYuy3uCFZYa7CE5S3UW6SrSa5nAqVQvtzRF9gw== +react-dom@^16.14.0: + version "16.14.0" + resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-16.14.0.tgz#7ad838ec29a777fb3c75c3a190f661cf92ab8b89" + integrity sha512-1gCeQXDLoIqMgqD3IO2Ah9bnf0w9kzhwN5q4FGnHZ67hBm9yePzB5JJAIQCc8x3pFnNlwFq4RidZggNAAkzWWw== + dependencies: + loose-envify "^1.1.0" + object-assign "^4.1.1" + prop-types "^15.6.2" + scheduler "^0.19.1" + react-is@^16.8.1: version "16.13.1" resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.13.1.tgz#789729a4dc36de2999dc156dd6c1d9c18cea56a4" integrity sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ== -react@^17.0.2: - version "17.0.2" - resolved "https://registry.yarnpkg.com/react/-/react-17.0.2.tgz#d0b5cc516d29eb3eee383f75b62864cfb6800037" - integrity sha512-gnhPt75i/dq/z3/6q/0asP78D0u592D5L1pd7M8P+dck6Fu/jJeL6iVVK23fptSUZj8Vjf++7wXA8UNclGQcbA== +react@^16.0.0: + version "16.14.0" + resolved "https://registry.yarnpkg.com/react/-/react-16.14.0.tgz#94d776ddd0aaa37da3eda8fc5b6b18a4c9a3114d" + integrity sha512-0X2CImDkJGApiAlcf0ODKIneSwBPhqJawOa5wCtKbu7ZECrmS26NvtSILynQ66cgkT/RJ4LidJOc3bUESwmU8g== dependencies: loose-envify "^1.1.0" object-assign "^4.1.1" + prop-types "^15.6.2" readable-stream@1.1.x: version "1.1.14" @@ -5520,6 +5531,14 @@ safe-buffer@^5.0.1, safe-buffer@^5.1.2, safe-buffer@~5.2.0: resolved "https://registry.yarnpkg.com/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a" integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg== +scheduler@^0.19.1: + version "0.19.1" + resolved "https://registry.yarnpkg.com/scheduler/-/scheduler-0.19.1.tgz#4f3e2ed2c1a7d65681f4c854fa8c5a1ccb40f196" + integrity sha512-n/zwRWRYSUj0/3g/otKDRPMh6qv2SYMWNq85IEa8iZyAv8od9zDYpGSnpBEjNgcMNq6Scbu5KfIPxNF72R/2EA== + dependencies: + loose-envify "^1.1.0" + object-assign "^4.1.1" + section-matter@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/section-matter/-/section-matter-1.0.0.tgz#e9041953506780ec01d59f292a19c7b850b84167"