Skip to content

Commit a72b058

Browse files
committed
docs: Update use of badges
1 parent b572209 commit a72b058

File tree

4 files changed

+16
-14
lines changed

4 files changed

+16
-14
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
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-1f425f.svg)](https://docsify.js.org/)
5+
[![GitHub release](https://img.shields.io/github/tag/MichaelCurrin/docsify-template.svg)](https://GitHub.com/MichaelCurrin/docsify-template/tags/)
6+
47
Convert your docs folder into a pretty docs website using [Docsify-JS](https://docsify.js.org/) and some minimal setup instructions. This project's doc site itself running on _Docsify_.
58

69
This project aims to use easy instructions for newcomers to Docsify and also includes as little effort as possible to get the quickstart / template project copied into your own project.

docs/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
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-1f425f.svg)](https://docsify.js.org/)
5+
[![GitHub release](https://img.shields.io/github/tag/MichaelCurrin/docsify-template.svg)](https://GitHub.com/MichaelCurrin/docsify-template/tags/)
6+
47
Convert your docs folder into a pretty docs website using [Docsify-JS](https://docsify.js.org/) and some minimal setup instructions. This project's doc site itself is also running on _Docsify_.
58

69
Two main sections of this project:
@@ -188,7 +191,7 @@ Example:
188191
189192
1. Ensure `loadSidebar: true` is set in the _index.html_ file.
190193
- The value of `true` means `*_sidebar.md*` will be referenced by the app.
191-
- The sidebar is already enabled in the quicksart [index.html](https://github.com/MichaelCurrin/docsify-template/blob/master/quickstart/index.html).
194+
- The sidebar is already enabled in the quickstart [index.html](https://github.com/MichaelCurrin/docsify-template/blob/master/quickstart/index.html).
192195
2. Edit the *_sidebar.md* file.
193196
3. Add items using the guidelines above.
194197
@@ -201,7 +204,7 @@ The clickable text above the standard sidebar takes you to the cover page. You c
201204
- [Home](/#my-app)
202205
```
203206
204-
NB. The leading forwardslash is **required** here for correct behavior. As the anchor tag will be invalid on other pages such as `foo.md` which has path `/#/foo/`).
207+
NB. The leading forward slash is **required** here for correct behavior. As the anchor tag will be invalid on other pages such as `foo.md` which has path `/#/foo/`).
205208
206209
The link is a reference to an anchor tag on the root URL, where anchor tag refers the ID of the homepage heading element. This ID will be created by _Docsify_. To find it, go to the coverpage, scroll down to the homepage and click on the heading. The URL will be something like `http://localhost:3000/#/?id=my-app`. The part we want is the end e.g. `my-app`.
207210
@@ -260,7 +263,7 @@ Replace the end of URL with one of these four themes:
260263
261264
You can optionally remove `/lib` from the theme URL to get the _uncompressed_ CSS file.
262265
263-
More on Docsify [themes](https://docsify.js.org/#/themes?id=themes) guide.
266+
Read more on the _Docsify_ [themes](https://docsify.js.org/#/themes?id=themes) guide.
264267
265268
### 7. Advanced configuration
266269

docs/_coverpage.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
![icon](_media/docs_face.png)
22

3-
# Docsify Template [![GitHub release](https://img.shields.io/github/tag/MichaelCurrin/docsify-template.svg)](https://GitHub.com/MichaelCurrin/docsify-template/tags/)
4-
> Tutorial for turning your project's docs folder into a docs site
3+
# Docsify Template
4+
> Tutorial for turning your project's docs folder into a docs site.
55
6-
- :hourglass_flowing_sand: Minimal effort to setup in a few minutes
7-
- :open_file_folder: No need to edit your existing doc files
8-
- :pushpin: No statically built HTML files
9-
- :hammer: No CLI tool required
6+
- :hourglass_flowing_sand: Setup in a few minutes
7+
- :open_file_folder: No need to reformat or restructure existing markdown docs
8+
- :pushpin: No static site generator needed
9+
- :hammer: No CLI tool required - library loads in the browser
1010
- :nut_and_bolt: Built on [Docsify-JS](https://docsify.js.org/)
11-
- :pizza: Serves locally or on Github Pages
11+
- :pizza: Serve locally or on Github Pages
1212

1313
[GitHub](https://github.com/michaelcurrin/docsify-template/)
1414
[Getting Started](#docsify-template)

quickstart/index.html

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,6 @@
1919
section.cover.show {
2020
height: 100%;
2121
}
22-
/* Override Docsify's block styling so that cover badge does not wrap. */
23-
section.cover h1 a {
24-
display: inline;
25-
}
2622

2723
</style>
2824
</head>

0 commit comments

Comments
 (0)