Skip to content

v5 preparation: updates and refactors #2428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .eslintignore
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
21 changes: 12 additions & 9 deletions .gitignore
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

11 changes: 7 additions & 4 deletions .prettierignore
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
4 changes: 1 addition & 3 deletions babel.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
[
"@babel/preset-env",
{
"targets": {
"node": "current"
}
"targets": "defaults"
}
]
]
Expand Down
159 changes: 0 additions & 159 deletions build/build.js

This file was deleted.

48 changes: 0 additions & 48 deletions build/css.js

This file was deleted.

21 changes: 0 additions & 21 deletions build/mincss.js

This file was deleted.

85 changes: 41 additions & 44 deletions docs/cdn.md
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>
```
Loading
Loading