-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
build: v5 updates and refactors (#2428)
* Update JS build - Change rollup build from API to config file - Change output dir from lib to dist - Update lib to dist path in related files - Update dependencies - Add banner comment to bundles - Add unminified plugin bundles * Update docs with v5 version lock and dist path * Update docs to reference minified themes * Clean up docs * Update CSS build - Change CSS build from API to CLI - Change output dir from lib to dist - Update lib to dist path in related files - Update dependencies - Add sourcemaps * Update dependencies * Clean up package.json and add keywords * Fix rimraf globs on Windows * Fix PostCSS CLI glob on Windows * Update test-related dependencies * Update emoji * Add engines prop to package.json
- Loading branch information
1 parent
b9f256d
commit 4ae87bb
Showing
35 changed files
with
4,513 additions
and
4,206 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,11 @@ | ||
# Directories | ||
.git | ||
**/*.md | ||
build | ||
dist | ||
docs | ||
lib | ||
node_modules | ||
|
||
# Files | ||
**/*.md | ||
server.js | ||
themes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,16 @@ | ||
.DS_Store | ||
# Directories | ||
.husky/_ | ||
.idea | ||
.vercel | ||
_playwright-report | ||
_playwright-results | ||
dist | ||
lib | ||
node_modules | ||
|
||
# Files | ||
.DS_Store | ||
*.log | ||
/_playwright-report | ||
/_playwright-results | ||
/lib | ||
/node_modules | ||
/.husky/_ | ||
|
||
# exceptions | ||
# Exceptions | ||
!.gitkeep | ||
.vercel | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,9 @@ | ||
# Directories | ||
_playwright-* | ||
dist | ||
lib | ||
|
||
# Files | ||
CHANGELOG.md | ||
HISTORY.md | ||
lib/ | ||
themes/ | ||
_playwright-*/ | ||
emoji-data.* | ||
HISTORY.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,9 +3,7 @@ | |
[ | ||
"@babel/preset-env", | ||
{ | ||
"targets": { | ||
"node": "current" | ||
} | ||
"targets": "defaults" | ||
} | ||
] | ||
] | ||
|
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,59 +1,56 @@ | ||
# CDN | ||
|
||
Recommended: [jsDelivr](//cdn.jsdelivr.net), which will reflect the latest version as soon as it is published to npm. You can also browse the source of the npm package at [cdn.jsdelivr.net/npm/docsify/](//cdn.jsdelivr.net/npm/docsify/). | ||
The docsify [npm package](https://www.npmjs.com/package/docsify) is auto-published to CDNs with each release. The contents can be viewed on each CDN. | ||
|
||
## Latest version | ||
Docsify recommends [jsDelivr](//cdn.jsdelivr.net) as its preferred CDN: | ||
|
||
```html | ||
<!-- load css --> | ||
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css" /> | ||
- https://cdn.jsdelivr.net/npm/docsify/ | ||
|
||
<!-- load script --> | ||
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.js"></script> | ||
``` | ||
Other CDNs are available and may be required in locations where jsDelivr is not available: | ||
|
||
Alternatively, use [compressed files](#compressed-file). | ||
- https://cdnjs.com/libraries/docsify | ||
- https://unpkg.com/browse/docsify/ | ||
- https://www.bootcdn.cn/docsify/ | ||
|
||
## Specific version | ||
## Specifying versions | ||
|
||
```html | ||
<!-- load css --> | ||
<link | ||
rel="stylesheet" | ||
href="//cdn.jsdelivr.net/npm/docsify@4.10.2/themes/vue.css" | ||
/> | ||
|
||
<!-- load script --> | ||
<script src="//cdn.jsdelivr.net/npm/docsify@4.10.2/lib/docsify.js"></script> | ||
``` | ||
Note the `@` version lock in the CDN URLs below. This allows specifying the latest major, minor, patch, or specific [semver](https://semver.org) version number. | ||
|
||
## Compressed file | ||
- MAJOR versions include breaking changes<br> | ||
`1.0.0` → `2.0.0` | ||
- MINOR versions include non-breaking new functionality<br> | ||
`1.0.0` → `1.1.0` | ||
- PATCH versions include non-breaking bug fixes<br> | ||
`1.0.0` → `1.0.1` | ||
|
||
```html | ||
<!-- load css --> | ||
<link | ||
rel="stylesheet" | ||
href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css" | ||
/> | ||
|
||
<!-- load script --> | ||
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script> | ||
``` | ||
Uncompressed resources are available by omitting the `.min` from the filename. | ||
|
||
## Latest "major" version | ||
|
||
Specifying the latest major version allows your site to receive all non-breaking enhancements ("minor" updates) and bug fixes ("patch" updates) as they are released. This is good option for those who prefer a zero-maintenance way of keeping their site up to date with minimal risk as new versions are published. | ||
|
||
?> When a new major version is released, you will need to manually update the major version number after the `@` symbol in your CDN URLs. | ||
|
||
<!-- prettier-ignore --> | ||
```html | ||
<!-- load css --> | ||
<link | ||
rel="stylesheet" | ||
href="//cdn.jsdelivr.net/npm/docsify@4.10.2/lib/themes/vue.css" | ||
/> | ||
|
||
<!-- load script --> | ||
<script src="//cdn.jsdelivr.net/npm/docsify@4.10.2/lib/docsify.min.js"></script> | ||
<!-- Theme --> | ||
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/themes/vue.min.css" /> | ||
|
||
<!-- Docsify --> | ||
<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script> | ||
``` | ||
|
||
## Other CDN | ||
## Specific version | ||
|
||
- https://www.bootcdn.cn/docsify/ | ||
- https://cdn.jsdelivr.net/npm/docsify/ | ||
- https://cdnjs.com/libraries/docsify | ||
- https://unpkg.com/browse/docsify/ | ||
Specifying an exact version prevents any future updates from affecting your site. This is good option for those who prefer to manually update their resources as new versions are published. | ||
|
||
?> When a new version is released, you will need to manually update the version number after the `@` symbol in your CDN URLs. | ||
|
||
<!-- prettier-ignore --> | ||
```html | ||
<!-- Theme --> | ||
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5.0.0/themes/vue.min.css" /> | ||
|
||
<!-- Docsify --> | ||
<script src="//cdn.jsdelivr.net/npm/docsify@5.0.0/dist/docsify.min.js"></script> | ||
``` |
Oops, something went wrong.