deploy: 6423c0a

docsifyjs · Dec 3, 2023 · 711f125 · 711f125
commit 711f125
Show file tree

Hide file tree

Showing 35 changed files with 7,302 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/CNAME b/CNAME
@@ -0,0 +1 @@
+docsify.js.org
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+## docsify
+
+> A magical documentation site generator.
+
+## What it is
+
+Docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as a website. To start using it, all you need to do is create an `index.html` and [deploy it on GitHub Pages](deploy.md).
+
+See the [Quick start](quickstart.md) guide for more details.
+
+## Features
+
+- No statically built html files
+- Simple and lightweight
+- Smart full-text search plugin
+- Multiple themes
+- Useful plugin API
+- Emoji support
+
+## Examples
+
+Check out the [Showcase](https://github.com/docsifyjs/awesome-docsify#showcase) to see docsify in use.
+
+## Donate
+
+Please consider donating if you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart:
+
+## Community
+
+Users and the development team are usually in the [Discord server](https://discord.gg/3NwKFyR).
diff --git a/_coverpage.md b/_coverpage.md
@@ -0,0 +1,12 @@
+![logo](_media/icon.svg)
+
+# docsify <small>4.13.0</small>
+
+> A magical documentation site generator.
+
+- Simple and lightweight
+- No statically built html files
+- Multiple themes
+
+[GitHub](https://github.com/docsifyjs/docsify/)
+[Getting Started](#docsify)
diff --git a/_images/deploy-github-pages.png b/_images/deploy-github-pages.png
diff --git a/_images/nested-navbar.png b/_images/nested-navbar.png
diff --git a/_images/zh-cn/nested-navbar.png b/_images/zh-cn/nested-navbar.png
diff --git a/_media/example-with-yaml.md b/_media/example-with-yaml.md
@@ -0,0 +1,6 @@
+---
+author: John Smith
+date: 2020-1-1
+---
+
+> This is from the `example.md`
diff --git a/_media/example.html b/_media/example.html
@@ -0,0 +1 @@
+<h1>To infinity and Beyond!</h1>
diff --git a/_media/example.js b/_media/example.js
@@ -0,0 +1,16 @@
+import fetch from 'fetch';
+
+const URL = 'https://example.com';
+const PORT = 8080;
+
+/// [demo]
+const result = fetch(`${URL}:${PORT}`)
+  .then(response => {
+    return response.json();
+  })
+  .then(myJson => {
+    console.log(JSON.stringify(myJson));
+  });
+/// [demo]
+
+result.then(console.log).catch(console.error);
diff --git a/_media/example.md b/_media/example.md
@@ -0,0 +1 @@
+> This is from the `example.md`
diff --git a/_media/favicon.ico b/_media/favicon.ico
diff --git a/_media/icon.svg b/_media/icon.svg
diff --git a/_media/powered-by-vercel.svg b/_media/powered-by-vercel.svg
diff --git a/_media/vercel_logo.svg b/_media/vercel_logo.svg
diff --git a/_navbar.md b/_navbar.md
@@ -0,0 +1,6 @@
+- Translations
+  - [:uk: English](/)
+  - [:cn: 简体中文](/zh-cn/)
+  - [:de: Deutsch](/de-de/)
+  - [:es: Español](/es/)
+  - [:ru: Русский](/ru-ru/)
diff --git a/_sidebar.md b/_sidebar.md
@@ -0,0 +1,28 @@
+- Getting started
+
+  - [Quick start](quickstart.md)
+  - [Writing more pages](more-pages.md)
+  - [Custom navbar](custom-navbar.md)
+  - [Cover page](cover.md)
+
+- Customization
+
+  - [Configuration](configuration.md)
+  - [Themes](themes.md)
+  - [List of Plugins](plugins.md)
+  - [Write a Plugin](write-a-plugin.md)
+  - [Markdown configuration](markdown.md)
+  - [Language highlighting](language-highlight.md)
+  - [Emoji](emoji.md)
+
+- Guide
+
+  - [Deploy](deploy.md)
+  - [Helpers](helpers.md)
+  - [Vue compatibility](vue.md)
+  - [CDN](cdn.md)
+  - [Offline Mode (PWA)](pwa.md)
+  - [Embed Files](embed-files.md)
+
+- [Awesome docsify](awesome.md)
+- [Changelog](changelog.md)
diff --git a/cdn.md b/cdn.md
@@ -0,0 +1,59 @@
+# CDN
+
+Recommended: [jsDelivr](//cdn.jsdelivr.net), which will reflect the latest version as soon as it is published to npm. You can also browse the source of the npm package at [cdn.jsdelivr.net/npm/docsify/](//cdn.jsdelivr.net/npm/docsify/).
+
+## Latest version
+
+```html
+<!-- load css -->
+<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css" />
+
+<!-- load script -->
+<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.js"></script>
+```
+
+Alternatively, use [compressed files](#compressed-file).
+
+## Specific version
+
+```html
+<!-- load css -->
+<link
+  rel="stylesheet"
+  href="//cdn.jsdelivr.net/npm/[email protected]/themes/vue.css"
+/>
+
+<!-- load script -->
+<script src="//cdn.jsdelivr.net/npm/[email protected]/lib/docsify.js"></script>
+```
+
+## Compressed file
+
+```html
+<!-- load css -->
+<link
+  rel="stylesheet"
+  href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css"
+/>
+
+<!-- load script -->
+<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+```
+
+```html
+<!-- load css -->
+<link
+  rel="stylesheet"
+  href="//cdn.jsdelivr.net/npm/[email protected]/lib/themes/vue.css"
+/>
+
+<!-- load script -->
+<script src="//cdn.jsdelivr.net/npm/[email protected]/lib/docsify.min.js"></script>
+```
+
+## Other CDN
+
+- https://www.bootcdn.cn/docsify/
+- https://cdn.jsdelivr.net/npm/docsify/
+- https://cdnjs.com/libraries/docsify
+- https://unpkg.com/browse/docsify/