From fdc3200ef4718eb98bd8a713f956222a9bf85ac9 Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Thu, 4 Aug 2022 16:40:44 +0200 Subject: docs: Add initial version of Docusaurus based docs This change updates the repository with a new Docusaurus-based documentation website. This allows us to create our documentation using Markdown, MDX and React. This will serve as the main entry point for users visiting https://opendc.org. The actual OpenDC application will be moved to https://app.opendc.org. --- site/package.json | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 site/package.json (limited to 'site/package.json') diff --git a/site/package.json b/site/package.json new file mode 100644 index 00000000..f2b317b2 --- /dev/null +++ b/site/package.json @@ -0,0 +1,43 @@ +{ + "name": "opendc-docs", + "version": "2.1.0", + "private": true, + "scripts": { + "docusaurus": "docusaurus", + "start": "docusaurus start", + "build": "docusaurus build", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "write-translations": "docusaurus write-translations", + "write-heading-ids": "docusaurus write-heading-ids" + }, + "dependencies": { + "@docusaurus/core": "^2.1.0", + "@docusaurus/preset-classic": "^2.1.0", + "@mdx-js/react": "^1.6.22", + "clsx": "^1.2.1", + "prism-react-renderer": "^1.3.5", + "react": "^17.0.2", + "react-dom": "^17.0.2" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "^2.1.0" + }, + "browserslist": { + "production": [ + ">0.5%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 1 chrome version", + "last 1 firefox version", + "last 1 safari version" + ] + }, + "engines": { + "node": ">=16.14" + } +} -- cgit v1.2.3 From e3abcf3ebc677a86fbd2c1d2da7241ac6a52595e Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Fri, 9 Sep 2022 22:08:52 +0200 Subject: build(site): Use Prettier to format JavaScript This change updates the build configuration for the OpenDC website to use Prettier to format the JavaScript files for that module. --- site/package.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'site/package.json') diff --git a/site/package.json b/site/package.json index f2b317b2..9075f170 100644 --- a/site/package.json +++ b/site/package.json @@ -11,7 +11,8 @@ "clear": "docusaurus clear", "serve": "docusaurus serve", "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids" + "write-heading-ids": "docusaurus write-heading-ids", + "format": "prettier --write src" }, "dependencies": { "@docusaurus/core": "^2.1.0", @@ -23,7 +24,8 @@ "react-dom": "^17.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "^2.1.0" + "@docusaurus/module-type-aliases": "^2.1.0", + "prettier": "^2.7.1" }, "browserslist": { "production": [ -- cgit v1.2.3