|
27 | 27 | </a> |
28 | 28 | </p> |
29 | 29 |
|
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. |
41 | 31 |
|
42 | 32 | ## Features |
43 | 33 |
|
|
48 | 38 | - Useful plugin API |
49 | 39 | - Support embedded files |
50 | 40 |
|
51 | | -## Quick start |
| 41 | +## Quick Start |
52 | 42 |
|
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. |
54 | 44 |
|
55 | 45 | [](https://codesandbox.io/s/307qqv236) |
56 | 46 |
|
57 | 47 | ## Showcase |
58 | 48 |
|
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). |
60 | 50 |
|
61 | | -Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase) |
| 51 | +## Links |
| 52 | + |
| 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) |
62 | 59 |
|
63 | | -## Similar projects |
| 60 | +## Similar Projects |
64 | 61 |
|
65 | 62 | | Project | Description | |
66 | 63 | | ------------------------------------------------ | ---------------------------------------- | |
67 | 64 | | [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 | 65 | | [MkDocs](https://www.mkdocs.org) | Project documentation with Markdown | |
70 | | -| [VuePress](https://vuepress.vuejs.org) | Vue-powered Static Site Generator | |
| 66 | +| [VitePress](https://vitepress.dev/) | Vite & Vue Powered Static Site Generator | |
71 | 67 |
|
72 | 68 | ## Contributing |
73 | 69 |
|
|
0 commit comments