Skip to content

Commit d43bd4c

Browse files
committed
Initial commit
1 parent b826fde commit d43bd4c

12 files changed

+153
-0
lines changed

.github/workflows/deploy.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Deploy
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: write # To push a branch
12+
pages: write # To push to a GitHub Pages site
13+
id-token: write # To update the deployment status
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
path: src
19+
- name: Setup Pages
20+
uses: actions/configure-pages@v4
21+
- name: Upload artifact
22+
uses: actions/upload-pages-artifact@v3
23+
with:
24+
# Upload entire repository
25+
path: 'src'
26+
- name: Deploy to GitHub Pages
27+
id: deployment
28+
uses: actions/deploy-pages@v4
29+

.nojekyll

Whitespace-only changes.

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Headline
2+
3+
> An awesome project.

_coverpage.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
![logo](_media/icon.svg)
2+
3+
# docsify <small>3.5</small>
4+
5+
> A magical documentation site generator.
6+
7+
- Simple and lightweight
8+
- No statically built html files
9+
- Multiple themes
10+
11+
[GitHub](https://github.com/docsifyjs/docsify/)
12+
[Get Started](#docsify)
13+
14+
![color](#f0f0f0)

_media/icon.svg

+30
Loading

_navbar.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
* Getting started
2+
3+
* [Quick start](quickstart.md)
4+
* [Writing more pages](more-pages.md)
5+
* [Custom navbar](custom-navbar.md)
6+
* [Cover page](cover.md)
7+
8+
* Configuration
9+
* [Configuration](configuration.md)
10+
* [Themes](themes.md)
11+
* [Using plugins](plugins.md)
12+
* [Markdown configuration](markdown.md)
13+
* [Language highlight](language-highlight.md)
14+
15+
* Language
16+
* [:us: United States](/en-us/)
17+
* [:uk: United Kingdom](/en-gb/)
18+
* [:cn: China](/zh-cn/)

_sidebar.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- _sidebar.md -->
2+
3+
- [Home](/)
4+
5+
- Section 1
6+
7+
- [My First Chapter](my-first-chapter.md)
8+
9+
- Section 2
10+
11+
- [README](nested/README.md)
12+
- [Sub-Chapter](nested/sub-chapter.md)

index.html

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>Document</title>
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
7+
<meta name="description" content="Description">
8+
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
9+
<!-- link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css" -->
10+
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/buble.css" />
11+
</head>
12+
<body>
13+
<!-- Custom navbar -->
14+
<!--
15+
<nav>
16+
<a href="#/">EN</a>
17+
<a href="#/zh-cn/">简体中文</a>
18+
</nav>
19+
-->
20+
<div id="app"></div>
21+
<script>
22+
window.$docsify = {
23+
name: 'Try Docsify',
24+
repo: 'https://github.com/gyk4j/try-docsify',
25+
loadSidebar: true,
26+
subMaxLevel: 2,
27+
alias: {
28+
'/.*/_sidebar.md': '/_sidebar.md'
29+
},
30+
loadNavbar: true,
31+
coverpage: true
32+
}
33+
</script>
34+
<!-- Docsify v4 -->
35+
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
36+
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js"></script>
37+
</body>
38+
</html>

my-first-chapter.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# My First Chapter
2+
3+
Fill out your content here.

nested/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Nested example

nested/_sidebar.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!-- nested/_sidebar.md -->
2+
3+
* [README](README.md)
4+
* [Sub-Chapter](sub-chapter.md)

nested/sub-chapter.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Sub-chapter

0 commit comments

Comments
 (0)