Skip to content

Commit 1629718

Browse files
authored
Merge branch 'develop' into ensure-code-format
2 parents 3bef45b + 6464cf5 commit 1629718

File tree

3 files changed

+19
-29
lines changed

3 files changed

+19
-29
lines changed

README.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,7 @@
2727
</a>
2828
</p>
2929

30-
## Links
31-
32-
- [`develop` branch preview](https://docsify-preview.vercel.app/)
33-
- [Documentation](https://docsify.js.org)
34-
- [CLI](https://github.com/docsifyjs/docsify-cli)
35-
- CDN:
36-
- [UNPKG](https://unpkg.com/docsify/)
37-
- [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/)
38-
- [cdnjs](https://cdnjs.com/libraries/docsify)
39-
- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
40-
- [Community chat](https://discord.gg/3NwKFyR)
30+
Docsify turns one or more Markdown files into a Website, with no build process required.
4131

4232
## Features
4333

@@ -48,26 +38,24 @@
4838
- Useful plugin API
4939
- Support embedded files
5040

51-
## Quick start
41+
## Quick Start
5242

53-
Look at [this tutorial](https://docsify.js.org/#/quickstart)
43+
Get going fast by using a static web server or GitHub Pages with this ready-to-use [Docsify Template](https://github.com/docsifyjs/docsify-template), review the [quick start tutorial](https://docsify.js.org/#/quickstart) or jump right into a CodeSandbox example site with the button below.
5444

5545
[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236)
5646

5747
## Showcase
5848

59-
These projects are using docsify to generate their sites. Pull requests welcome :blush:
49+
A large collection of showcase projects are included in [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase).
6050

61-
Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase)
62-
63-
## Similar projects
51+
## Links
6452

65-
| Project | Description |
66-
| -------------------------------------- | ----------------------------------------------------------------------- |
67-
| [Docusaurus](https://docusaurus.io) | Docusaurus makes it easy to maintain Open Source documentation websites |
68-
| [GitBook](https://www.gitbook.com) | Where technical teams document |
69-
| [MkDocs](https://www.mkdocs.org) | Project documentation with Markdown |
70-
| [VuePress](https://vuepress.vuejs.org) | Vue-powered Static Site Generator |
53+
- [Documentation](https://docsify.js.org)
54+
- [Docsify CLI (Command Line Interface)](https://github.com/docsifyjs/docsify-cli)
55+
- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
56+
- [`develop` branch preview](https://docsify-preview.vercel.app/)
57+
- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
58+
- [Community chat](https://discord.gg/3NwKFyR)
7159

7260
## Contributing
7361

docs/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -838,11 +838,13 @@ For more details, see [#1131](https://github.com/docsifyjs/docsify/issues/1131).
838838

839839
> **Warning** Deprecated. Use the CSS var `--theme-color` in your `<style>` sheet. Example:
840840
>
841+
> ```html
841842
> <style>
842843
> :root {
843844
> --theme-color: deeppink;
844845
> }
845846
> </style>
847+
> ```
846848
847849
- Type: `String`
848850

package-lock.json

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)