Hosted Docsify

Feature request

What problem does this feature solve?

This feature solves the problem of the developer having to deploy and host the index.html file ourselves. As a developer, I don’t want to have to setup and host (via Github Pages or anywhere else) the static HTML file that Docsify runs on. Instead I would prefer a freemium solution that allows me to leverage an HTML page that is hosted by Docsify/Vercel and configured via URL parameters.

What does the proposed API look like?

https://docsify.js.org/preview?config=...docsify config or more simply https://docsify.js.org/preview?basePath=https://github.com/feathersjs-ecosystem/batch-loader/tree/v2/docs

How should this be implemented in your opinion?

• Docsify/Vercel would host a static HTML page. For example https://docsify.js.org/preview.
• On page load, some javascript would extract the Docsify config from the URL using something like qs or querystring preferably to more easily allow JSON in the URL, but SearchParams could also be used.
• The config extracted from the URL is passed to the Docsify init javascript. We could also extend the config to include other items like theme=dark that would dynamically write in the corresponding theme’s css.
• Docsify does its thing!

I understand that there are a number of caveats and lack of customization with this approach. The user can’t write their own custom CSS, etc. But thats fine IMO. I want a bare-bones, dead-simple solution where I can just include the link in my README and not think about it.

Are you willing to work on this yourself?

Yes. But this more of a business/admin decision I believe. I am capable and willing to write the HTML page and JS to accomplish this.

[paulhibbitts]

Hi @DaddyWarbucks , I thought you might be interested in seeing what has developed so far with your Remote Docsify example🙂 https://docsify-this.net/#/

If you would like any changes to the credit to yourself at the bottom of the page please let me know!

[paulhibbitts]

Thanks again for this remote Docsify example @DaddyWarbucks! I’ve now created a collection of my various Docsify ReadMe’s using your technique at https://hibbitts-design.github.io/docsify-project-docs/#/ and have credited you in the ReadMe and Index.html file at https://github.com/hibbitts-design/docsify-project-docs.