Basic docsify support #270
Conversation
index.html
Outdated
| <script> | ||
| window.$docsify = { | ||
| name: 'pino', | ||
| loadSidebar: true, |
There was a problem hiding this comment.
The documentation says this can be a string path to the sidebar file. How about /docsify/sidebar.md instead?
There was a problem hiding this comment.
I'll see what I can do.
| @@ -0,0 +1,23 @@ | |||
| <!DOCTYPE html> | |||
There was a problem hiding this comment.
Shouldn't this file be in /docs?
There was a problem hiding this comment.
If we place this file in /docs, we would have to duplicate our README. I thought it was preferrable this way.
There was a problem hiding this comment.
I'm really unclear about where it is supposed to be placed. The documentation is very lacking in this area (and in general, really).
There was a problem hiding this comment.
Does the basePath configuration variable alleviate needing to update the readme?
There was a problem hiding this comment.
The needs come from howe we configure gh-pages. You can configure to use the things in docs/ or in /. If you use the first, you can't access anything in /.
|
@jsumners I moved the sidebar into the Are you folks ok if we publish this? It seems better than nothing :). |
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
This commit adds docsify support to our docs. Test with
npm install docsify-cli -gdocsify serve .Try it and let me know what you think.
Fixes #269.