Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
lorchr committed May 20, 2023
0 parents commit 4f54002
Show file tree
Hide file tree
Showing 91 changed files with 13,542 additions and 0 deletions.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 环境
- node 12
- npm 6.14.16

# 安装

```shell
npm install -g docsify-cli
```

# 初始化

```shell
mkdir light-docsify && cd light-docsify
docsify init ./docs
```

# 运行

```shell
docsify serve ./docs
```

# 推送仓库

```shell
echo "# light-docsify" >> README.md
git init
git add README.md
git commit -m "first commit"
git branch -M main
git remote add origin [email protected]:lorchr/light-docsify.git
git push -u origin main
```

# 部署站点
- [deploy](https://docsify.js.org/#/deploy)
- [Github Pages](https://docsify.js.org/#/deploy?id=github-pages)
- [Gitlab Pages](https://docsify.js.org/#/deploy?id=gitlab-pages)
- [Firebase-Hosting](https://docsify.js.org/#/deploy?id=firebase-hosting)
- [VPS](https://docsify.js.org/#/deploy?id=vps)
- [Netlify](https://docsify.js.org/#/deploy?id=netlify)
- [Vercel](https://docsify.js.org/#/deploy?id=vercel)
- [AWS-Amplify](https://docsify.js.org/#/deploy?id=aws-amplify)
- [Docker](https://docsify.js.org/#/deploy?id=docker)

点击进入项目的Settings页面`https://github.com/lorchr/light-docsify/settings/pages`

`Settings` -> `Pages` -> `Build and deployment`
Source : Deploy from a branch
Branch : Main docs
Save and visit `https://lorchr.github.io/light-docsify`
Empty file added docs/.nojekyll
Empty file.
5 changes: 5 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@


# Headline

> An awesome project.
11 changes: 11 additions & 0 deletions docs/_coverpage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
![logo](https://docsify.js.org/_media/icon.svg)
# Torch
> Torch, Light the world!
* Java相关:jdk、jvm、
* 框架技术:spring、mybatis
* 中间件:es、mq、redis
* 数据库技术:mysql

[Get Started](README.md)
[GitHub](https://github.com/lorch/light-docsify)
8 changes: 8 additions & 0 deletions docs/_navbar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
* language
* [:cn:](/zh-cn/)
* [:us:](/en-us/)
* [:uk:](/en-us/)
* 文档中心
* [Torch](/zh-cn/)
* [官方文档](/docsify/zh-cn/)
* [Offical Dcoument](/docsify/en-us/)
31 changes: 31 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
* [首页](/zh-cn/)
* [指南](/zh-cn/guide/guide)
* [Docsite](/zh-cn/guide/Docsite-Usage)
* [开发环境](/zh-cn/devenv/devenv)
* Linux
* Common
* [HTTPS-cert-apply-for-free](/zh-cn/linux/common/HTTPS-cert-apply-for-free)
* [Ntp-Time-Sync](/zh-cn/linux/common/Ntp-Time-Sync)
* Install
* [Install-JDK](/zh-cn/linux/install/Install-JDK)
* [Install-NodeJS](/zh-cn/linux/install/Install-NodeJS)
* [Install-Maven](/zh-cn/linux/install/Install-Maven)
* [Install-Gitea](/zh-cn/linux/install/Install-Gitea)
* [Install-Nexus3](/zh-cn/linux/install/Install-Nexus3)
* [Install-Jenkins](/zh-cn/linux/install/Install-Jenkins)
* [Install-Docker-Registry](/zh-cn/linux/install/Install-Docker-Registry)
* [Install-Harbor](/zh-cn/linux/install/Install-Harbor)
* K8s
* [K8s-Single-Master-Cluster](/zh-cn/k8s/K8s-Single-Master-Cluster)
* [Use-Rancher-build-K8s-Cluster](/zh-cn/k8s/Use-Rancher-build-K8s-Cluster)
* Spring Boot
* [Spring Boot](/zh-cn/spring-boot/Spring-Boot)
* [Unit-test-in-spring-boot-application](/zh-cn/spring-boot/Unit-test-in-spring-boot-application)
* Spring Security
* [Spring Security](/zh-cn/spring-security/Spring-Security)
* OAuth2
* [Spring-authorization-server](/zh-cn/spring-security/oauth2/Spring-authorization-server)
* Spring Cloud
* [Spring Cloud](/zh-cn/spring-cloud/Spring-Cloud)
* Database
* [PDManer](/zh-cn/database/PDManer)
Empty file added docs/docsify/en-us/.nojekyll
Empty file.
1 change: 1 addition & 0 deletions docs/docsify/en-us/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docsify.js.org
32 changes: 32 additions & 0 deletions docs/docsify/en-us/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## 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
- Compatible with IE11
- Support server-side rendering ([example](https://github.com/docsifyjs/docsify-ssr-demo))

## 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).
12 changes: 12 additions & 0 deletions docs/docsify/en-us/_coverpage.md
Original file line number Diff line number Diff line change
@@ -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)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docsify/en-us/_images/nested-navbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/docsify/en-us/_media/example-with-yaml.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
author: John Smith
date: 2020-1-1
---

> This is from the `example.md`
1 change: 1 addition & 0 deletions docs/docsify/en-us/_media/example.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<h1>To infinity and Beyond!</h1>
16 changes: 16 additions & 0 deletions docs/docsify/en-us/_media/example.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import fetch from 'fetch'

const URL = 'https://example.com'
const PORT = 8080

/// [demo]
const result = fetch(`${URL}:${PORT}`)
.then(function (response) {
return response.json()
})
.then(function (myJson) {
console.log(JSON.stringify(myJson))
})
/// [demo]

result.then(console.log).catch(console.error)
1 change: 1 addition & 0 deletions docs/docsify/en-us/_media/example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
> This is from the `example.md`
Binary file added docs/docsify/en-us/_media/favicon.ico
Binary file not shown.
30 changes: 30 additions & 0 deletions docs/docsify/en-us/_media/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/docsify/en-us/_media/powered-by-vercel.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/docsify/en-us/_media/vercel_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/docsify/en-us/_navbar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
- Translations
- [:uk: English](/)
- [:cn: 简体中文](/zh-cn/)
- [:de: Deutsch](/de-de/)
- [:es: Español](/es/)
- [:ru: Русский](/ru-ru/)
29 changes: 29 additions & 0 deletions docs/docsify/en-us/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
- Getting started

- [Quick start](docsify/en-us/quickstart.md)
- [Writing more pages](docsify/en-us/more-pages.md)
- [Custom navbar](docsify/en-us/custom-navbar.md)
- [Cover page](docsify/en-us/cover.md)

- Customization

- [Configuration](docsify/en-us/configuration.md)
- [Themes](docsify/en-us/themes.md)
- [List of Plugins](docsify/en-us/plugins.md)
- [Write a Plugin](docsify/en-us/write-a-plugin.md)
- [Markdown configuration](docsify/en-us/markdown.md)
- [Language highlighting](docsify/en-us/language-highlight.md)
- [Emoji](docsify/en-us/emoji.md)

- Guide

- [Deploy](docsify/en-us/deploy.md)
- [Helpers](docsify/en-us/helpers.md)
- [Vue compatibility](docsify/en-us/vue.md)
- [CDN](docsify/en-us/cdn.md)
- [Offline Mode (PWA)](docsify/en-us/pwa.md)
- [Server-Side Rendering (SSR)](docsify/en-us/ssr.md)
- [Embed Files](docsify/en-us/embed-files.md)

- [Awesome docsify](docsify/en-us/awesome.md)
- [Changelog](docsify/en-us/changelog.md)
50 changes: 50 additions & 0 deletions docs/docsify/en-us/cdn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 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/
Loading

0 comments on commit 4f54002

Please sign in to comment.