docs: add static

2026-01-12 22:46:48 +08:00 · 2019-03-31 15:01:56 +08:00
parent d81a1e89a3
commit b87c3c77ae
2 changed files with 51 additions and 0 deletions
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@@ -23,6 +23,7 @@
  - [Offline Mode(PWA)](pwa.md)
  - [Server-Side Rendering(SSR)](ssr.md)
  - [Embed Files](embed-files.md)
+  - [Generate static html](static.md)

 - [Awesome docsify](awesome.md)
 - [Changelog](changelog.md)
--- a/docs/static.md
+++ b/docs/static.md
@@ -0,0 +1,50 @@
+# Generate static html
+
+_Experimental feature_
+
+Generating static html files is good for SEO and speeds up the first rendering.
+
+But this is not an advantage of docsify. If you only need powerful static documentation, choose another documentation tool like Gitbook or Vuepress.
+
+## Configuration
+
+You can configure it in a special config file.
+
+_config.js_
+
+```js
+module.exports = {
+  template: `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>My Doc</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css" title="vue">
+</head>
+<body>
+  <!--inject-app-->
+  <!--inject-config-->
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+</body>
+</html>`, // or html file path
+
+  config: {
+    // docsify config
+    coverpage: true
+  }
+};
+```
+
+## Generate
+
+Please use docsify-cli 5.0+ and run this command.
+
+```sh
+docsify static docs -c config.js
+```
+
+## Simple Demo
+
+This is an example showing the docsify official documentation generating static files. [docsify-static-demo](https://github.com/docsifyjs/docsify-static-demo)