From 772296c47a7ac8bfa5ba41b95913306f574bd53a Mon Sep 17 00:00:00 2001 From: Joe Pea Date: Mon, 15 Jun 2020 17:43:10 -0700 Subject: [PATCH 1/4] update CI names --- .github/workflows/e2e.yml | 38 +++++++++++++++++++------------------- .github/workflows/lint.yml | 38 +++++++++++++++++++------------------- .github/workflows/unit.yml | 38 +++++++++++++++++++------------------- 3 files changed, 57 insertions(+), 57 deletions(-) diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml index 09fd229fa..0f6b677e6 100644 --- a/.github/workflows/e2e.yml +++ b/.github/workflows/e2e.yml @@ -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: @@ -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 diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 8e40422e8..787a2027c 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -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: @@ -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 diff --git a/.github/workflows/unit.yml b/.github/workflows/unit.yml index 45c001f7a..6b5b5b8ba 100644 --- a/.github/workflows/unit.yml +++ b/.github/workflows/unit.yml @@ -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: @@ -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 From e35628d7a904a6d010dd9444029b0cb0d5e403c4 Mon Sep 17 00:00:00 2001 From: Joe Pea Date: Mon, 15 Jun 2020 19:59:10 -0700 Subject: [PATCH 2/4] update README badges, move status badges to the bottom --- README.md | 53 +++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 43 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index fdef0a95d..da0109dcd 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,31 @@

- Backers on Open Collective - - Sponsors on Open Collective - Unit tests Suite - Linting Checks - Testing the e2e test suites - npm - donate - gitter - Gitpod Ready-to-Code + Join Discord community and chat about Docsify + Backers and sponsors on Open Collective + Support Docsify development + Install Docsify from NPM + Contribute to or play around with Docsify on Gitpod

Gold Sponsor via Open Collective

@@ -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)]. +## Status + +Docsify unit test suite +Docsify linting checks +Docsify e2e test suites + ## License [MIT](LICENSE) From 06c1f116399fc1b66c676021260188362e207674 Mon Sep 17 00:00:00 2001 From: Joe Pea Date: Mon, 15 Jun 2020 20:20:58 -0700 Subject: [PATCH 3/4] use shields.io for status badges --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index da0109dcd..4cecb678c 100644 --- a/README.md +++ b/README.md @@ -140,17 +140,17 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR Docsify unit test suite -Docsify linting checks Docsify e2e test suites +Docsify linting checks ## License From 99047e3a804fbd2b2b0776d679e8cde1b646573e Mon Sep 17 00:00:00 2001 From: Joe Pea Date: Mon, 15 Jun 2020 20:42:10 -0700 Subject: [PATCH 4/4] docs: change existing gitter links to discord links and remove gitter widget --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- README.md | 2 +- cypress/fixtures/tpl/docs.index.html | 11 ----------- docs/README.md | 4 ++-- docs/index.html | 6 ------ 5 files changed, 4 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f7ec3af1c..cde218821 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,7 +7,7 @@ about: Create a report to help us improve - + ## Bug Report diff --git a/README.md b/README.md index 4cecb678c..e33a35bbe 100644 --- a/README.md +++ b/README.md @@ -51,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 diff --git a/cypress/fixtures/tpl/docs.index.html b/cypress/fixtures/tpl/docs.index.html index 6a8b41a4c..774ab99fb 100644 --- a/cypress/fixtures/tpl/docs.index.html +++ b/cypress/fixtures/tpl/docs.index.html @@ -108,16 +108,5 @@ - - - diff --git a/docs/README.md b/docs/README.md index e62542032..ab381bff5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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. @@ -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). diff --git a/docs/index.html b/docs/index.html index 050b21dde..320b5d5a2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -98,12 +98,6 @@ - -