mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-11-30 02:58:37 +08:00
7bbf13d9bd
* chore: add missing Vue support for Vercel builds * refactor: move some functions and module-level state into classes as private methods and properties to start to encapsulate Docsify Also some small tweaks: - move initGlobalAPI out of Docsify.js to start to encapsulate Docsify - move ajax to utils folder - fix some type definitions and improve content in some JSDoc comments - use concise class field syntax - consolidate duplicate docsify-ignore comment removal code This handles a task in [Simplify and modernize Docsify](https://github.com/docsifyjs/docsify/issues/2104), as well as works towards [Encapsulating Docsify](https://github.com/docsifyjs/docsify/issues/2135). * chore: add prettier code format check to our lint script, and add a prettier script for manually formatting the whole code base * chore: update issue/pr templates * chore: apply our format to the whole code base --------- Co-authored-by: Koy <koy@ko8e24.top> Co-authored-by: i544693 <369491420@qq.com>
128 lines
4.6 KiB
JSON
128 lines
4.6 KiB
JSON
{
|
|
"name": "docsify",
|
|
"version": "4.13.0",
|
|
"description": "A magical documentation generator.",
|
|
"homepage": "https://docsify.js.org",
|
|
"repository": "github:docsifyjs/docsify",
|
|
"authors": "https://github.com/docsifyjs/docsify/graphs/contributors",
|
|
"license": "MIT",
|
|
"collective": {
|
|
"url": "https://opencollective.com/docsify"
|
|
},
|
|
"type": "module",
|
|
"// The 'main' and 'unpkg' fields will remain as legacy for backwards compatbility for now. We will add deprectaion warnings to these outputs to give people time to see the warnings in their apps in a non-breaking way, and eventually we can remove the legacy stuff.": "",
|
|
"main": "lib/docsify.js",
|
|
"unpkg": "lib/docsify.min.js",
|
|
"// We're using the 'exports' field as an override of the 'main' field to provide the new ESM setup. Once we remove legacy 'main', we will remove the 'exports' field and have a simple ESM setup with only a 'main' field.": "",
|
|
"exports": {
|
|
".": "./src/Docsify.js",
|
|
"./*": "./*"
|
|
},
|
|
"files": [
|
|
"lib",
|
|
"themes"
|
|
],
|
|
"scripts": {
|
|
"build:cover": "node build/cover.js",
|
|
"build:css:min": "mkdirp lib/themes && npm run css -- -o lib/themes && node build/mincss.js",
|
|
"build:css": "mkdirp themes && npm run css -- -o themes",
|
|
"build:emoji": "node ./build/emoji.js",
|
|
"build:js": "cross-env NODE_ENV=production node build/build.js",
|
|
"build:test": "npm run build && npm test",
|
|
"build": "rimraf lib themes && run-s build:js build:css build:css:min build:cover build:emoji",
|
|
"css": "node build/css",
|
|
"dev": "run-p serve watch:*",
|
|
"docker:build:test": "npm run docker:cli -- build:test",
|
|
"docker:build": "docker build -f Dockerfile -t docsify-test:local .",
|
|
"docker:clean": "docker rmi docsify-test:local",
|
|
"docker:cli": "docker run --rm -it --ipc=host --mount type=bind,source=$(pwd)/test,target=/app/test docsify-test:local",
|
|
"docker:rebuild": "npm run docker:clean && npm run docker:build",
|
|
"docker:test:e2e": "npm run docker:cli -- test:e2e",
|
|
"docker:test:integration": "npm run docker:cli -- test:integration",
|
|
"docker:test:unit": "npm run docker:cli -- test:unit",
|
|
"docker:test": "npm run docker:cli -- test",
|
|
"prettier": "prettier . --write",
|
|
"lint:fix": "eslint . --fix",
|
|
"lint": "prettier . --check && eslint .",
|
|
"postinstall": "opencollective-postinstall",
|
|
"prepare": "npm run build",
|
|
"pub:next": "cross-env RELEASE_TAG=next sh build/release.sh",
|
|
"pub": "sh build/release.sh",
|
|
"serve": "node server",
|
|
"test:e2e": "playwright test",
|
|
"test:integration": "npm run jest -- --selectProjects integration",
|
|
"test:unit": "npm run jest -- --selectProjects unit",
|
|
"test": "npm run jest && run-s test:e2e",
|
|
"jest": "cross-env NODE_OPTIONS=--experimental-vm-modules jest",
|
|
"watch:css": "npm run css -- -o themes -w",
|
|
"watch:js": "node build/build.js"
|
|
},
|
|
"husky": {
|
|
"hooks": {
|
|
"pre-commit": "lint-staged"
|
|
}
|
|
},
|
|
"lint-staged": {
|
|
"*.js": "eslint --fix"
|
|
},
|
|
"dependencies": {
|
|
"marked": "^4.2.12",
|
|
"medium-zoom": "^1.0.8",
|
|
"opencollective-postinstall": "^2.0.2",
|
|
"prismjs": "^1.29.0",
|
|
"strip-indent": "^3.0.0",
|
|
"tinydate": "^1.3.0",
|
|
"tweezer.js": "^1.4.0"
|
|
},
|
|
"devDependencies": {
|
|
"@babel/core": "^7.11.6",
|
|
"@babel/eslint-parser": "^7.16.5",
|
|
"@babel/preset-env": "^7.11.5",
|
|
"@eslint/js": "^8.43.0",
|
|
"@playwright/test": "^1.18.1",
|
|
"@rollup/plugin-commonjs": "^25.0.2",
|
|
"@rollup/plugin-node-resolve": "^15.1.0",
|
|
"@rollup/plugin-replace": "^5.0.2",
|
|
"@rollup/plugin-terser": "^0.4.3",
|
|
"@types/eslint": "^8.40.2",
|
|
"autoprefixer-stylus": "^1.0.0",
|
|
"axios": "^0.21.1",
|
|
"babel-jest": "^27.4.6",
|
|
"browser-sync": "^2.26.12",
|
|
"chokidar": "^3.4.2",
|
|
"common-tags": "^1.8.0",
|
|
"conventional-changelog-cli": "^3.0.0",
|
|
"copy-dir": "^1.2.0",
|
|
"cross-env": "^7.0.3",
|
|
"cssnano": "^4.1.10",
|
|
"eslint": "^8.43.0",
|
|
"eslint-config-prettier": "^8.8.0",
|
|
"eslint-plugin-import": "^2.27.5",
|
|
"eslint-plugin-jest": "^27.2.2",
|
|
"eslint-plugin-playwright": "^0.15.1",
|
|
"eslint-plugin-prettier": "^4.2.1",
|
|
"globals": "^13.20.0",
|
|
"husky": "^8.0.3",
|
|
"jest": "^27.4.7",
|
|
"lint-staged": "^13.2.2",
|
|
"live-server": "^1.2.1",
|
|
"mkdirp": "^3.0.0",
|
|
"npm-run-all": "^4.1.5",
|
|
"prettier": "^2.8.8",
|
|
"rimraf": "^3.0.0",
|
|
"rollup": "^3.25.3",
|
|
"serve-handler": "^6.1.2",
|
|
"stylus": "^0.59.0",
|
|
"vue2": "npm:vue@^2.6.12",
|
|
"vue3": "npm:vue@^3.0.0",
|
|
"xhr-mock": "^2.5.1"
|
|
},
|
|
"keywords": [
|
|
"doc",
|
|
"docs",
|
|
"documentation",
|
|
"creator",
|
|
"generator"
|
|
]
|
|
}
|