Skip to content

Commit 7f23d1d

Browse files
committed
docs: Rename repo
1 parent 708f283 commit 7f23d1d

File tree

4 files changed

+19
-19
lines changed

4 files changed

+19
-19
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
> Tutorial on how to build a docs site with _Docsify-JS_ and _Github Pages_, including an easy quickstart template
33
44
[![Made with latest Docsify](https://img.shields.io/npm/v/docsify?label=docsify)](https://docsify.js.org/)
5-
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-template.svg)](https://GitHub.com/MichaelCurrin/docsify-template/tags/)
6-
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-template/blob/master/LICENSE)
5+
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-js-tutorial.svg)](https://GitHub.com/MichaelCurrin/docsify-js-tutorial/tags/)
6+
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/LICENSE)
77

88
Docs site:
99

10-
- https://michaelcurrin.github.io/docsify-template/#/
10+
- https://michaelcurrin.github.io/docsify-js-tutorial/#/
1111

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

@@ -17,7 +17,7 @@ This project will guide you on how to convert your project's docs folder into a
1717
The idea is to:
1818

1919
- add as little code and configuration as possible
20-
- make it easy to maintain
20+
- make it easy to maintain
2121
- quick to get setup on existing projects
2222
- have no layout files
2323
- reduce dependencies
@@ -35,7 +35,7 @@ _Docsify_ works as a single-page application on this one page - data from your m
3535

3636
The tutorial is available in two forms:
3737

38-
- Github Pages: [docs site](https://michaelcurrin.github.io/docsify-template/#/). This also live demo of the kind of site you would have after completing the tutorial.
38+
- Github Pages: [docs site](https://michaelcurrin.github.io/docsify-js-tutorial/#/). This also live demo of the kind of site you would have after completing the tutorial.
3939
- Project docs: View the docs as plain markdown format in the repo, either locally or on Github. See the [docs](/docs) directory.
4040

4141
The tutorial references the [quickstart](/quickstart) directory at the project root, in case you want to see that.

docs/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
> How to build a docs site with _Docsify-JS_ and Github Pages
33
44
[![Made with latest Docsify](https://img.shields.io/npm/v/docsify?label=docsify)](https://docsify.js.org/)
5-
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-template.svg)](https://GitHub.com/MichaelCurrin/docsify-template/tags/)
6-
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-template/blob/master/LICENSE)
5+
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-js-tutorial.svg)](https://GitHub.com/MichaelCurrin/docsify-js-tutorial/tags/)
6+
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/LICENSE)
77

88
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_.
99

@@ -89,13 +89,13 @@ Clone this repo to your machine with one of these commands:
8989

9090
```bash
9191
$ # Clone with SSH
92-
$ git clone [email protected]:MichaelCurrin/docsify-template.git
92+
$ git clone [email protected]:MichaelCurrin/docsify-js-tutorial.git
9393
$ # Clone with HTTPS
94-
$ git clone https://github.com/MichaelCurrin/docsify-template.git
94+
$ git clone https://github.com/MichaelCurrin/docsify-js-tutorial.git
9595
```
9696

9797
```bash
98-
$ cd docsify-template
98+
$ cd docsify-js-tutorial
9999
```
100100

101101
No installation is needed. When the HTML page is opened in the browser, the _Docsify_ library will be fetched from a CDN by the browser.
@@ -127,13 +127,13 @@ Clone this template repo to your machine using one of the steps below, so you ca
127127

128128
```bash
129129
$ # Clone with SSH
130-
$ git clone [email protected]:MichaelCurrin/docsify-template.git
130+
$ git clone [email protected]:MichaelCurrin/docsify-js-tutorial.git
131131
$ # Clone with HTTPS
132-
$ git clone https://github.com/MichaelCurrin/docsify-template.git
132+
$ git clone https://github.com/MichaelCurrin/docsify-js-tutorial.git
133133
```
134134

135135
```bash
136-
$ cd docsify-template
136+
$ cd docsify-js-tutorial
137137
```
138138

139139
### 2. Create base structure
@@ -190,13 +190,13 @@ How to setup a sidebar file:
190190
191191
Example:
192192
193-
[_sidebar.md](https://raw.githubusercontent.com/MichaelCurrin/docsify-template/master/nested_example/_sidebar.md ':include :type=code')
193+
[_sidebar.md](https://raw.githubusercontent.com/MichaelCurrin/docsify-js-tutorial/master/nested_example/_sidebar.md ':include :type=code')
194194
195195
##### Setup custom sidebar
196196
197197
1. Ensure `loadSidebar: true` is set in the _index.html_ file.
198198
- The value of `true` means `*_sidebar.md*` will be referenced by the app.
199-
- The sidebar is already enabled in the quickstart [index.html](https://github.com/MichaelCurrin/docsify-template/blob/master/quickstart/index.html).
199+
- The sidebar is already enabled in the quickstart [index.html](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/quickstart/index.html).
200200
2. Edit the *_sidebar.md* file.
201201
3. Add items using the guidelines above.
202202
@@ -218,7 +218,7 @@ This is really the text of heading element, which has been made lowercase and hy
218218
219219
The cover page is the first page that a visitor sees before scrolling down to the homepage.
220220
221-
If you want to use it, edit your *docs/_coverpage.md* file and complete the `TODO` items. You can also use this project's [cover page](https://raw.githubusercontent.com/MichaelCurrin/docsify-template/master/docs/_coverpage.md) on Github as a reference.
221+
If you want to use it, edit your *docs/_coverpage.md* file and complete the `TODO` items. You can also use this project's [cover page](https://raw.githubusercontent.com/MichaelCurrin/docsify-js-tutorial/master/docs/_coverpage.md) on Github as a reference.
222222

223223
You can add additional buttons to the bottom of the homepage, but there should be no gaps between the lines in your file. And the last one will be solid while the others will be transparent.
224224

docs/_coverpage.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@
1010
- :nut_and_bolt: Built on [Docsify-JS](https://docsify.js.org/)
1111
- :pizza: Serve locally or on Github Pages
1212

13-
[GitHub](https://github.com/michaelcurrin/docsify-template/)
14-
[Getting Started](#docsify-template)
13+
[GitHub](https://github.com/michaelcurrin/docsify-js-tutorial/)
14+
[Getting Started](#docsify-js-tutorial)

docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<script>
2929
window.$docsify = {
3030
name: 'Docsify Template',
31-
repo: 'https://github.com/michaelcurrin/docsify-template',
31+
repo: 'https://github.com/michaelcurrin/docsify-js-tutorial',
3232
auto2top: true, // This helps a lot when switching between sections by menu.
3333
coverpage: true,
3434
loadSidebar: false,

0 commit comments

Comments
 (0)