Skip to content

Commit

Permalink
refactor: delete the experimental and incomplete SSR feature
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
trusktr committed Jun 25, 2023
1 parent 4b9b464 commit 8d5d204
Show file tree
Hide file tree
Showing 24 changed files with 16,442 additions and 26,767 deletions.
2 changes: 1 addition & 1 deletion .codesandbox/ci.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"sandboxes": ["2d17z"],
"packages": [".", "packages/docsify-server-renderer"],
"packages": ["."],
"node": "16"
}
1 change: 0 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@ build
docs
lib
node_modules
packages/docsify-server-renderer/build.js
server.js
themes
1 change: 0 additions & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ module.exports = {
yoda: ['error', 'never'],

// Import rules
// Search way how integrate with `lerna`
'import/imports-first': ['error'],
'import/newline-after-import': ['error'],
'import/no-duplicates': ['error'],
Expand Down
45 changes: 41 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

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

We welcome any type of contribution, not only code. You can help with
We welcome any type of contribution, not only code. You can help with

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

## Your First Contribution

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).
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).

## Online one-click setup for Contributing

You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click it'll launch a workspace and automatically:

- clone the docsify repo.
- install the dependencies.
- start `npm run dev`.

```bash
npm install && npm run dev
```

So that you can start straight away.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify)

- Fork it!
- Create your feature branch: `git checkout -b my-new-feature`
- Commit your changes: `git add . && git commit -m 'Add some feature'`
- Push to the branch: `git push origin my-new-feature`
- Submit a pull request

## Submitting code

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.

## Testing

Ensure that things work by running:

```sh
npm test
```

## Test Snapshots

If a snapshot fails, or to add new snapshots, run:

```sh
npx jest --updateSnapshot
```

## Code review process

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.
Expand All @@ -41,14 +80,12 @@ You can also reach us at hello@docsify.opencollective.com.
Thank you to all the people who have already contributed to docsify!
<a href="graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a>


### Backers

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

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


### Sponsors

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))
Expand Down
23 changes: 1 addition & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
- Multiple themes
- Useful plugin API
- Compatible with IE11
- Experimental SSR support ([example](https://github.com/docsifyjs/docsify-ssr-demo))
- Support embedded files

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

## Contributing

### Online one-click setup for Contributing

You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click it'll launch a workspace and automatically:

- clone the docsify repo.
- install the dependencies.
- start `npm run dev`.

```bash
npm install && npm run dev
```

So that you can start straight away.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify)

- Fork it!
- Create your feature branch: `git checkout -b my-new-feature`
- Commit your changes: `git add . && git commit -m 'Add some feature'`
- Push to the branch: `git push origin my-new-feature`
- Submit a pull request
See [CONTRIBUTING.md](./CONTRIBUTING.md).

## Backers

Expand Down
1 change: 0 additions & 1 deletion build/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ async function build(opts) {
nodeResolve(),
replace({
__VERSION__: version,
'process.env.SSR': false
})
]),
onwarn: function (message) {
Expand Down
15 changes: 2 additions & 13 deletions build/release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,11 @@ echo
if [[ $REPLY =~ ^[Yy]$ ]]; then
echo "Releasing $VERSION ..."

# Removing test script as non - availibity of tests. Will Add it once tests are completed

# npm run test

# build
VERSION=$VERSION npm run build

# update packages
cd packages/docsify-server-renderer
npm version $VERSION
if [[ -z $RELEASE_TAG ]]; then
npm publish
else
npm publish --tag $RELEASE_TAG
fi
cd -
# TODO
# npm test

# commit
git add -A
Expand Down
35 changes: 0 additions & 35 deletions build/ssr.js

This file was deleted.

1 change: 0 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ See the [Quick start](quickstart.md) guide for more details.
- Useful plugin API
- Emoji support
- Compatible with IE11
- Support server-side rendering ([example](https://github.com/docsifyjs/docsify-ssr-demo))

## Examples

Expand Down
1 change: 0 additions & 1 deletion docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
- [Vue compatibility](vue.md)
- [CDN](cdn.md)
- [Offline Mode (PWA)](pwa.md)
- [Server-Side Rendering (SSR)](ssr.md)
- [Embed Files](embed-files.md)

- [Awesome docsify](awesome.md)
Expand Down
131 changes: 0 additions & 131 deletions docs/ssr.md

This file was deleted.

4 changes: 0 additions & 4 deletions lerna.json

This file was deleted.

Loading

0 comments on commit 8d5d204

Please sign in to comment.