Skip to content

update readme, add Discord to site, other improvements/changes #1224

New issue

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

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

Already on GitHub? # to your account

Closed
wants to merge 5 commits into from
Closed
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ about: Create a report to help us improve
<!-- Please use English language -->
<!-- Before creating an issue please make sure you are using the latest version of Docsify. -->
<!-- Please ask questions on StackOverflow: https://stackoverflow.com/questions/ask?tags=docsify -->
<!-- Please ask questions on gitter: https://gitter.im/docsifyjs/Lobby -->
<!-- Please ask questions on Discord: https://discord.gg/3NwKFyR -->

## Bug Report

Expand Down
38 changes: 19 additions & 19 deletions .github/workflows/e2e.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
name: Testing the e2e test suites
name: e2e tests

on:
on:
push:
branches:
- master
- develop
branches:
- master
- develop
pull_request:
branches:
- master
- develop
branches:
- master
- develop

jobs:
build:
Expand All @@ -18,14 +18,14 @@ jobs:
node-version: [10.x, 12.x, 13.x]

steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: bootstrap
run: npm run bootstrap
- name: Build
run: npm run build
- name: end to end
run: npm run test:e2e
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: bootstrap
run: npm run bootstrap
- name: Build
run: npm run build
- name: end to end
run: npm run test:e2e
38 changes: 19 additions & 19 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
name: Linting Checks
name: lint checks

on:
on:
push:
branches:
- master
- develop
branches:
- master
- develop
pull_request:
branches:
- master
- develop
branches:
- master
- develop

jobs:
build:
Expand All @@ -18,14 +18,14 @@ jobs:
node-version: [10.x, 12.x, 13.x]

steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: bootstrap
run: npm run bootstrap
- name: Build
run: npm run build
- name: Linting
run: npm run lint
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: bootstrap
run: npm run bootstrap
- name: Build
run: npm run build
- name: Linting
run: npm run lint
38 changes: 19 additions & 19 deletions .github/workflows/unit.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
name: Unit tests Suite
name: unit tests

on:
on:
push:
branches:
- master
- develop
branches:
- master
- develop
pull_request:
branches:
- master
- develop
branches:
- master
- develop

jobs:
build:
Expand All @@ -18,14 +18,14 @@ jobs:
node-version: [10.x, 12.x, 13.x]

steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: bootstrap
run: npm run bootstrap
- name: Build
run: npm run build
- name: Unit tests
run: npm run test
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: bootstrap
run: npm run bootstrap
- name: Build
run: npm run build
- name: Unit tests
run: npm run test
55 changes: 44 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,31 @@
</p>

<p align="center">
<a href="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/docsify/backers/badge.svg?style=flat-square"></a>
<a href="#sponsors">
<img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a>
<a><img src="https://github.com/docsifyjs/docsify/workflows/Unit%20tests%20Suite/badge.svg?branch=develop&amp;event=push" alt="Unit tests Suite"></a>
<a><img src="https://github.com/docsifyjs/docsify/workflows/Linting%20Checks/badge.svg?branch=develop&amp;event=push" alt="Linting Checks"></a>
<a><img src="https://github.com/docsifyjs/docsify/workflows/Testing%20the%20e2e%20test%20suites/badge.svg?branch=develop&amp;event=push" alt="Testing the e2e test suites"></a>
<a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
<a href="https://github.com/QingWei-Li/donate"><img alt="donate" src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square"></a>
<a href="https://gitter.im/docsifyjs/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link"><img alt="gitter" src="https://img.shields.io/gitter/room/docsifyjs/docsify.svg?style=flat-square"></a>
<a href="https://gitpod.io/#https://github.com/docsifyjs/docsify"><img src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"></a>
<a href="https://discord.gg/3NwKFyR"><img
alt="Join Discord community and chat about Docsify"
title="Join Discord community and chat about Docsify"
src="https://img.shields.io/discord/713647066802421792.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&cacheSeconds=60"
/></a>
<a href="#backers"><img
alt="Backers and sponsors on Open Collective"
title="Backers and sponsors on Open Collective"
src="https://img.shields.io/opencollective/all/docsify?label=supporters&cacheSeconds=86400"
/></a>
<a href="https://github.com/QingWei-Li/donate"><img
alt="Support Docsify development"
title="Support Docsify development"
src="https://img.shields.io/badge/$-donate-ff69b4.svg"
/></a>
<a href="https://www.npmjs.com/package/docsify"><img
alt="Install Docsify from NPM"
title="Install Docsify from NPM"
src="https://img.shields.io/npm/v/docsify.svg?&label=&logo=npm&logoColor=ffffff&labelColor=eeeeee&color=cb3837&cacheSeconds=86400"
/></a>
<a href="https://gitpod.io/#https://github.com/docsifyjs/docsify"><img
alt="Contribute to or play around with Docsify on Gitpod"
title="Contribute to or play around with Docsify on Gitpod"
src="https://img.shields.io/badge/gitpod-gray?logo=gitpod"
/></a>
</p>

<p align="center">Gold Sponsor via <a href="https://opencollective.com/docsify">Open Collective</a></p>
Expand All @@ -36,7 +51,7 @@
- [CLI](https://github.com/docsifyjs/docsify-cli)
- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
- [Community chat](https://gitter.im/docsifyjs/Lobby)
- [Community chat](https://discord.gg/3NwKFyR)

## Features

Expand Down Expand Up @@ -120,6 +135,24 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/docsifyjs/docsify/graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a>

## Status

<a href="https://github.com/docsifyjs/docsify/actions?query=workflow%3A%22unit+tests%22"><img
alt="Docsify unit test suite"
title="Docsify unit test suite"
src="https://img.shields.io/github/workflow/status/docsifyjs/docsify/unit tests/develop?label=unit%20tests&cacheSeconds=300"
/></a>
<a href="https://github.com/docsifyjs/docsify/actions?query=workflow%3A%22e2e+tests%22"><img
alt="Docsify e2e test suites"
title="Docsify e2e test suites"
src="https://img.shields.io/github/workflow/status/docsifyjs/docsify/e2e tests/develop?label=e2e%20tests&cacheSeconds=300"
/></a>
<a href="https://github.com/docsifyjs/docsify/actions?query=workflow%3A%22lint+checks%22"><img
alt="Docsify linting checks"
title="Docsify linting checks"
src="https://img.shields.io/github/workflow/status/docsifyjs/docsify/lint checks/develop?label=lint%20checks&cacheSeconds=300"
/></a>

## License

[MIT](LICENSE)
11 changes: 0 additions & 11 deletions cypress/fixtures/tpl/docs.index.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,16 +108,5 @@
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>

<script>
;((window.gitter = {}).chat = {}).options = {
room: 'docsifyjs/Lobby'
}
</script>
<script
src="https://sidecar.gitter.im/dist/sidecar.v1.js"
async
defer
></script>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## What it is

docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as a website. To start using it, all you need to do is create an `index.html` and [deploy it on GitHub Pages](deploy.md).
Docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as a website. To start using it, all you need to do is create an `index.html` and [deploy it on GitHub Pages](deploy.md).

See the [Quick start](quickstart.md) guide for more details.

Expand All @@ -29,4 +29,4 @@ Please consider donating if you think docsify is helpful to you or that my work

## Community

Users and the development team are usually in the [Gitter chat room](https://gitter.im/docsifyjs/Lobby).
Users and the development team are usually in the [Discord server](https://discord.gg/3NwKFyR).
6 changes: 0 additions & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,6 @@
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-markdown.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-nginx.min.js"></script>
<script>
((window.gitter = {}).chat = {}).options = {
room: 'docsifyjs/Lobby'
};
</script>
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
</body>

</html>