Generate static HTML site (static site generation, SSG)

[acathur]

Eagerly waiting for this function, maybe it can be added to docsify-cli.

EDIT by maintainers:

• This is from #802 (The original Implementation)
• We can either continue on #802 or create a fresh PR for this (@QingWei-Li thoughts ?)
• docsify-cli implementation ref https://github.com/docsifyjs/docsify-cli/pull/55
• Original issue https://github.com/docsifyjs/docsify/issues/136

[QingWei-Li]

Sorry I don't have time to do now 😣, if you are interested, you can contribute.

[jrappen]

For comparison, maybe this is a start?

• https://github.com/webpro/reveal-md/blob/master/lib/static.js

[egoist]

so why not use gitbook 😄

[jrappen]

I found madoko:

• via npm
• https://www.madoko.net
• https://github.com/koka-lang/madoko
  • https://github.com/koka-lang/madoko/blob/gh-pages/reference.pdf
• https://www.microsoft.com/en-us/research/video/madoko-a-scholarly-markdown

You can:

• output static HTML
• output PDF
• include files
• style code in code blocks

[egoist]

@jrappen that looks cool, but seems it does the same things that gitbook can do

[dietergoetelen]

@QingWei-Li I'm new to docsify, would love to see this feature. I'm interested in contributing, can you point me in the right direction?

[egoist]

@dietergoetelen Seems the SSR API can achieve this https://docsify.js.org/#/ssr?id=deploy-for-your-vps

[QingWei-Li]

Hi @dietergoetelen, Now part of the compiler can run in Node, you can refer to docsify-server-renderer. We can read the files and then compile them like docsify-server-renderer do the same. Would you like to try it?

[maoueh]

@QingWeil-Li Was this close because it's now possible? Won’t fix?

[QingWei-Li]

@maoueh

GitBook is recommended if you need to build static files.

[luishdez]

But GitBook is a paid product, It's only free for "non private" projects. Can we at least leave the PR Welcome?

[gottlike]

@QingWei-Li

A really simple solution would be to just add a print-css and reference the browser print function with a simple button (printing to PDF can then be chosen by the user). What do you think?

[KerimG]

+1 on the feature request.

[sheljohn]

@jrappen I stumbled upon Madoko a while back. The main issue with it is that it is written in Koka, which no one knows apart from its author Daan Leijen, who is also the author of that package. For a while it was hosted on CodePlex, and it was really difficult to find the sources, let alone understand them, or contribute. I suppose this is now on GitHub because MS acquired the company... The reference manual looks absolutely amazing, and it's difficult to think that only one person is behind this; but IMO that summarises the project well. It looks awesome, but it's a black-box, written in sanskrit, with a single contributor.

@egoist Have a look at the reference manual; it serves a different purpose than GitBook. Madoko was designed to write scientific publication-like content; it supports LaTeX maths, internal references, citations, and footnotes out of the box. GitBook is meant to be an advanced documentation-writing tool, oriented towards web-publishing. Let us not compare pears and apples.

[weituotian]

@QingWei-Li can it output pdf? need!

[ideacco]

+1 on the feature request.

[yhhwpp]

+1 on the feature request.

[justerhan]

https://github.com/egoist/presite might be useful here

[trusktr]

Anyone that wants this feature, why do you want it? Has the live client-side markdown rendering been too slow for you? Is it hindering your user experience?

I am just curious, because performance updates for the sake of performance updates may not be as productive use of time compared to other features that are being planned. Please let us know if you encountered any performance problems that make a difference to the user experience (so far I haven't seen one that is significant, but it could be possible if you have giant markdown pages then that's an issue, for example).

@anikethsaha Since you listed this in v5, I'll re-open and add it to the 5.0 project so we can track it.

[justerhan]

Mostly because static files are easy to deploy across a cdn Service like Netlify

On Sun, May 10, 2020, 15:50 Joe Pea [email protected] wrote:

Just curious, anyone that wants this feature, why do you want it? Has the live client-side markdown rendering been too slow for you? Is it hindering your user experience?

@anikethsaha https://github.com/anikethsaha Since you listed this in v5, I'll re-open and add it to the 5.0 project so we can track it.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/docsifyjs/docsify/issues/136#issuecomment-626401785, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAGTNWYJT5DYMQ5ELKDQPTLRQ4VSPANCNFSM4DEBBIDA .

[trusktr]

@bountyx Markdown files are also static files.

[trusktr]

Ah! SEO!

That's a good reason to serve HTML, to make things more indexable by search engines.

[anikethsaha]

@trusktr there is an issue with plugins. most of the things in docsify is a plugin. we cant make them work if we don't have the DOM. So either we need to do it with jsdom while but this won't give 100% accurate results.

This will be a blocking issue for v5.

[trusktr]

Maybe also doesn't have to be for 5.0, it can be for "when it's ready". :) It's a bit complex.

Maybe we can build it on NW.js instead of JSDom.

[anikethsaha]

@trusktr yeah, we can remove this from the roadmap, this will be blocking issue

[trusktr]

👍

[vagra]

+1 on the feature request.

I using docsify for a online converter:

1. it can convert opml outline file to md;
2. then preview the md file using docsify;
3. and using the docsify server renderer, convert the md file to html file;
4. then using WeasyPrint (python package) convert html to PDF.

now i am blocked in the step 3. because docsify server renderer have some probreams:

1. it can't set basePath to local location;
2. I don't know how to save the rendered content to an html file at server.

[vagra]

need 2 function:

1. generate static html files for all docs;
2. genarate a html file for a specific doc;

[anikethsaha]

We have a blocking issue as plugins won't work if there is no DOM. Many plugins are using browser's features like local storage.

So i am not sure how long it will take or even it will be done or not

[trusktr]

Do plugins work with Docsify's SSR?