Skip to content

Commit 8d5d204

Browse files
committed
refactor: delete the experimental and incomplete SSR feature
BREAKING: SSR removed Anyone depending on SSR will need to stay on an old Docsify version for now, move forward without SSR, or maintain SSR against a fork of updated Docsify. We have ideas on a better way to implement SSR, but these ideas have not been implemented yet.
1 parent 4b9b464 commit 8d5d204

File tree

24 files changed

+16442
-26767
lines changed

24 files changed

+16442
-26767
lines changed

.codesandbox/ci.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"sandboxes": ["2d17z"],
3-
"packages": [".", "packages/docsify-server-renderer"],
3+
"packages": ["."],
44
"node": "16"
55
}

.eslintignore

-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,5 @@ build
44
docs
55
lib
66
node_modules
7-
packages/docsify-server-renderer/build.js
87
server.js
98
themes

.eslintrc.js

-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ module.exports = {
6363
yoda: ['error', 'never'],
6464

6565
// Import rules
66-
// Search way how integrate with `lerna`
6766
'import/imports-first': ['error'],
6867
'import/newline-after-import': ['error'],
6968
'import/no-duplicates': ['error'],

CONTRIBUTING.md

+41-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
First, thank you for considering contributing to docsify! It's people like you that make the open source community such a great community! 😊
66

7-
We welcome any type of contribution, not only code. You can help with
7+
We welcome any type of contribution, not only code. You can help with
8+
89
- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
910
- **Marketing**: writing blog posts, howto's, printing stickers, ...
1011
- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
@@ -13,12 +14,50 @@ We welcome any type of contribution, not only code. You can help with
1314

1415
## Your First Contribution
1516

16-
Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
17+
Working on your first Pull Request ever? You can learn how from this _free_ series, [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
18+
19+
## Online one-click setup for Contributing
20+
21+
You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click it'll launch a workspace and automatically:
22+
23+
- clone the docsify repo.
24+
- install the dependencies.
25+
- start `npm run dev`.
26+
27+
```bash
28+
npm install && npm run dev
29+
```
30+
31+
So that you can start straight away.
32+
33+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify)
34+
35+
- Fork it!
36+
- Create your feature branch: `git checkout -b my-new-feature`
37+
- Commit your changes: `git add . && git commit -m 'Add some feature'`
38+
- Push to the branch: `git push origin my-new-feature`
39+
- Submit a pull request
1740

1841
## Submitting code
1942

2043
Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.
2144

45+
## Testing
46+
47+
Ensure that things work by running:
48+
49+
```sh
50+
npm test
51+
```
52+
53+
## Test Snapshots
54+
55+
If a snapshot fails, or to add new snapshots, run:
56+
57+
```sh
58+
npx jest --updateSnapshot
59+
```
60+
2261
## Code review process
2362

2463
The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.
@@ -41,14 +80,12 @@ You can also reach us at [email protected].
4180
Thank you to all the people who have already contributed to docsify!
4281
<a href="graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a>
4382

44-
4583
### Backers
4684

4785
Thank you to all our backers! [[Become a backer](https://opencollective.com/docsify#backer)]
4886

4987
<a href="https://opencollective.com/docsify#backers" target="_blank"><img src="https://opencollective.com/docsify/backers.svg?width=890"></a>
5088

51-
5289
### Sponsors
5390

5491
Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/docsify#sponsor))

README.md

+1-22
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@
4444
- Multiple themes
4545
- Useful plugin API
4646
- Compatible with IE11
47-
- Experimental SSR support ([example](https://github.com/docsifyjs/docsify-ssr-demo))
4847
- Support embedded files
4948

5049
## Quick start
@@ -68,27 +67,7 @@ Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase)
6867

6968
## Contributing
7069

71-
### Online one-click setup for Contributing
72-
73-
You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click it'll launch a workspace and automatically:
74-
75-
- clone the docsify repo.
76-
- install the dependencies.
77-
- start `npm run dev`.
78-
79-
```bash
80-
npm install && npm run dev
81-
```
82-
83-
So that you can start straight away.
84-
85-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify)
86-
87-
- Fork it!
88-
- Create your feature branch: `git checkout -b my-new-feature`
89-
- Commit your changes: `git add . && git commit -m 'Add some feature'`
90-
- Push to the branch: `git push origin my-new-feature`
91-
- Submit a pull request
70+
See [CONTRIBUTING.md](./CONTRIBUTING.md).
9271

9372
## Backers
9473

build/build.js

-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ async function build(opts) {
3030
nodeResolve(),
3131
replace({
3232
__VERSION__: version,
33-
'process.env.SSR': false
3433
})
3534
]),
3635
onwarn: function (message) {

build/release.sh

+2-13
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,11 @@ echo
1212
if [[ $REPLY =~ ^[Yy]$ ]]; then
1313
echo "Releasing $VERSION ..."
1414

15-
# Removing test script as non - availibity of tests. Will Add it once tests are completed
16-
17-
# npm run test
18-
1915
# build
2016
VERSION=$VERSION npm run build
2117

22-
# update packages
23-
cd packages/docsify-server-renderer
24-
npm version $VERSION
25-
if [[ -z $RELEASE_TAG ]]; then
26-
npm publish
27-
else
28-
npm publish --tag $RELEASE_TAG
29-
fi
30-
cd -
18+
# TODO
19+
# npm test
3120

3221
# commit
3322
git add -A

build/ssr.js

-35
This file was deleted.

docs/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ See the [Quick start](quickstart.md) guide for more details.
1717
- Useful plugin API
1818
- Emoji support
1919
- Compatible with IE11
20-
- Support server-side rendering ([example](https://github.com/docsifyjs/docsify-ssr-demo))
2120

2221
## Examples
2322

docs/_sidebar.md

-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
- [Vue compatibility](vue.md)
2323
- [CDN](cdn.md)
2424
- [Offline Mode (PWA)](pwa.md)
25-
- [Server-Side Rendering (SSR)](ssr.md)
2625
- [Embed Files](embed-files.md)
2726

2827
- [Awesome docsify](awesome.md)

docs/ssr.md

-131
This file was deleted.

lerna.json

-4
This file was deleted.

0 commit comments

Comments
 (0)