Skip to content

Commit c66d928

Browse files
docs: Add Github Pages help
1 parent 04d354e commit c66d928

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,8 @@ More on Docsify [themes](https://docsify.js.org/#/themes?id=themes) guide.
231231
232232
### 7. Advanced configuration
233233
234+
This advanced section is optional, so can be skipped.
235+
234236
The configuration steps above already get you a prettier and more usable site in my opinion than the barebones one which the _Docsify_ `init` command or their _Quickstart_ guide gives you.
235237
236238
If you want to do further configuration, I recommend you look at the _Docsify_ [Configuration](https://docsify.js.org/#/configuration) page.
@@ -239,6 +241,15 @@ There are some useful things there in like adjusting the sidebar levels, puttin
239241
240242
If you want know a summary view of what the defaults are for the app on `index.html`, see the _Docsify_ [config.js](https://github.com/docsifyjs/docsify/blob/develop/src/core/config.js) script.
241243
244+
## Setup Github Pages site
245+
246+
If you followed the steps above, you'll have a locally running docs site.
247+
248+
Now, commit and push the files to Github.
249+
250+
Next, edit your repo's setting on Github. Select the option to serve your `master` directory as a Github Pages site. If you refresh the settings page, you will see a link to your site there.
251+
252+
Open the link in the browser.
242253
243254
## Docsify CLI
244255

0 commit comments

Comments
 (0)