You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -134,16 +134,16 @@ Clone this template repo to your machine using the [steps](#get-a-local-copy-of-
134
134
135
135
### 3. Configure homepage
136
136
137
-
Edit the _docs/README.md_ homepage. Complete the `TODO` items, using the suggestions in this section.
137
+
Edit your homepage (_docs/README.md_). Complete the `TODO` items, using the suggestions in this section.
138
138
139
-
- Anything outside of your _docs_ directory will **not** be served online. Therefore you might want copy the the content from your project root's _README.md_ to the _docs/README.md_. After that, you might want to make the root _README.md_ very short, if you don't want to worry about keeping two identical files in sync.
140
-
- You might want to opt forshort _docs/README.md_ file if you prefer to put more documentationin other _docs_ files.
141
-
- Note that you are not required to put in links to other docs file within your _docs/README.md_ file. As that is what the _Docsify_ sidebar. If you do put in any links in_docs/README.md_, they must be **relative** to the _docs_ directory such as `file.md`, as absolute URLs such `/docs/file.md` will not work within the _docs_ site.
139
+
- Anything outside of your _docs_ directory will **not** be served. Therefore you might want copy the the content from your project root's _README.md_ to the homepage. After that, you could make the root _README.md_ very short, if you don't want to worry about keeping two identical files in sync.
140
+
- You might want to opt forshort homepage file if you prefer to put more documentationin other _docs_ files.
141
+
- Note that you are not required to put in links to other docs file within your homepage file. As that is what the _Docsify_ sidebar. If you do put in any links inyour homepage, they must be relative to the _docs_ directory, such as `file.md`. See [Doc links](#doc-links) for more info.
142
142
143
143
144
144
### 4. Configure menu structure
145
145
146
-
If forsome reason you do not want a navigation sidebar on the frontend, then delete *_sidebar.md* from your _docs_ directory, set the sidebar option to `false`in _index.html_ and skip to the next section - [Configure Cover Page](#5-configure-cover-page)
146
+
If forsome reason you do not want a navigation sidebar on the frontend, then you should delete *_sidebar.md* from your _docs_ directory, set the `loadSidebar` option to `false`in _index.html_ andthen skip to the next section - [Configure Cover Page](#5-configure-cover-page)
147
147
148
148
The sidebar is enabled in _index.html_ of the quickstart. A Docsify site is unaware of project structure, unless you provide it.
0 commit comments