Skip to content

Commit d9c2dee

Browse files
committed
docs: Update Docsify badges
1 parent 6a0fb89 commit d9c2dee

3 files changed

Lines changed: 11 additions & 8 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# Docsify Template
22
> Tutorial on how to build a docs site with _Docsify-JS_ and _Github Pages_, including an easy quickstart template
33
4-
[![Made with Docsify](https://img.shields.io/badge/Made%20with-Docsify-blue.svg)](https://docsify.js.org/)
4+
[![Made with latest Docsify](https://img.shields.io/npm/v/docsify?label=docsify)](https://docsify.js.org/)
55
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-template.svg)](https://GitHub.com/MichaelCurrin/docsify-template/tags/)
66
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-template/blob/master/LICENSE)
77

88
This project will guide you to convert your project's docs folder into a pretty docs website. This project's own docs site is built on _Docsify-JS_ so serves as a good example.
99

1010
## Project aims
1111

12-
The idea is to add as little code as possible, to make it easy to maintain and quick to get going. The tool used here is [Docsify-JS](https://docsify.js.org/) but no prior knowledge is needed, so this is ideal for newcomers.
12+
The idea is to add as little code as possible, to make it easy to maintain and quick to get going. The tool used here is [Docsify-JS](https://docsify.js.org/) but no prior knowledge is needed, so this is ideal for newcomers.
1313

14-
The tutorial covers the basics and provides minimal setup instructions. You can add the quickstart project to your **existing** docs folder. If you doc files are markdown files, you don't have to rename them and their formatting can mostly stay the same (links may need updating).
14+
The tutorial covers the basics and provides minimal setup instructions. You can add the quickstart project to your **existing** docs folder. If you doc files are markdown files, you don't have to rename them and their formatting can mostly stay the same (links may need updating).
1515

16-
Unlike static site builders like Jekyll or Hugo, you do not need to install or run a site generator or change the formatting or metadata of your markdown files. Your also don't need any config files - the configuration is handled in the _index.html_ page, which is also where dependencies are fetched in the browser and where the app starts.
16+
Unlike static site builders like Jekyll or Hugo, you do not need to install or run a site generator or change the formatting or metadata of your markdown files. Your also don't need any config files - the configuration is handled in the _index.html_ page, which is also where dependencies are fetched in the browser and where the app starts.
1717

1818
_Docsify_ works as a single-page application on this one page - data from your markdown files is pulled in and displayed within the _Docsify_ UI shell. There are no template layout files to manage.
1919

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Docsify Template
22
> How to build a docs site with _Docsify-JS_ and Github Pages
33
4-
[![Made with Docsify](https://img.shields.io/badge/Made%20with-Docsify-blue.svg)](https://docsify.js.org/)
4+
[![Made with latest Docsify](https://img.shields.io/npm/v/docsify?label=docsify)](https://docsify.js.org/)
55
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-template.svg)](https://GitHub.com/MichaelCurrin/docsify-template/tags/)
66
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-template/blob/master/LICENSE)
77

@@ -298,12 +298,12 @@ See some values below which are worth considering for the siderbar.
298298
window.$docsify = {
299299
// Maximum Table of Contents (TOC) level. Default value shown here.
300300
maxLevel: 6,
301-
301+
302302
// Add table of contents (TOC) in custom sidebar. Default value shown here. Try a value of 2.
303303
subMaxLevel: 0,
304-
304+
305305
logo: '/_media/icon.svg',
306-
306+
307307
name: 'docsify'
308308
}
309309
```

quickstart/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
# My Project Name
33
> My project description
44
5+
<!-- Choose one of these Docsify badges. The first is just text, the second looks up the latest npm version and displays it. -->
56
[![Made with Docsify](https://img.shields.io/badge/Made%20with-Docsify-blue.svg)](https://docsify.js.org/)
7+
[![Made with latest Docsify](https://img.shields.io/npm/v/docsify/latest?label=docsify)](https://docsify.js.org/)
8+
69
[![GitHub tag](https://img.shields.io/github/tag/<USERNAME>/<REPO-NAME>.svg)](https://GitHub.com/<USERNAME>/<REPO-NAME>/tags/) <!-- TODO: Update repo links.-->
710
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/<USERNAME>/<REPO-NAME>/blob/master/LICENSE) <!-- TODO: Update repo link and change license type if not MIT. -->
811

0 commit comments

Comments
 (0)