-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
124 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 docsifyjs | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Docsify Template | ||
|
||
> A simple [Docsify](https://github.com/docsifyjs/docsify/) template for creating Markdown-based documentation sites, with no build process required. | ||
## Site Setup | ||
|
||
### Static Webserver | ||
Upload these template files to any static web server. The file `.nojekyll` is only required if hosting the site on GitHub Pages and otherwise can be removed. | ||
|
||
### GitHub Pages | ||
|
||
#### Hosting Site | ||
|
||
To host this template on GitHub Pages do the following: | ||
|
||
1. Log into GitHub if you have not done so already | ||
2. Tap the **Use this template** button in the upper-right of this GitHub Repository and choose **Create a new repository** | ||
3. Enter a name for your new Repository and then tap the **Create repository** button | ||
4. Once your new Repostitory is created go to **Settings**, then select **Pages** from the left-hand sidebar, and under **Branch** choose **main** and then tap the **Save** button | ||
5. Wait a minute or two and refresh the same **Pages** page - once your site is ready a message will be displayed at the top of the screen along with a site link and a **Visit site** button | ||
|
||
#### Editing Content | ||
|
||
How about editing the content of your new Docsify site on GitHub Pages? View the Markdown page you want to edit (for example, **README.md**) and tap the **Pencil Icon**, then save any changes by tapping the green **Commit changes...** button. In just a few moments the Docsify site will be automatically updated to reflect those changes. | ||
|
||
### Viewing Locally | ||
Run `npx serve .` (Node.js users) or `python -m http.server 8000` (Python users) in the repo folder to serve run locally. | ||
|
||
## Docsify Documentation | ||
|
||
To learn more about using Docsify, visit https://docsify.js.org. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
- [Read Me](README) | ||
- [Example Second Page](second-page) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
<head> | ||
<meta charset="utf-8" /> | ||
<meta | ||
name="viewport" | ||
content="width=device-width, initial-scale=1, minimum-scale=1.0, shrink-to-fit=no, viewport-fit=cover" | ||
/> | ||
|
||
<!-- Replace with your own title and description. --> | ||
<title>Ledo - documentation</title> | ||
<meta name="description" content="Ledo documentation site." /> | ||
|
||
<!-- Default Theme (see https://docsify.js.org/#/themes) --> | ||
<link | ||
rel="stylesheet" | ||
href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css" | ||
/> | ||
</head> | ||
|
||
<body> | ||
<div id="app"></div> | ||
<script type="module"> | ||
import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs"; | ||
mermaid.initialize({ startOnLoad: true }); | ||
window.mermaid = mermaid; | ||
</script> | ||
|
||
<script> | ||
// Docsify Configuration (see https://docsify.js.org/#/configuration) | ||
window.$docsify = { | ||
name: "Ledo documentation", | ||
|
||
// Sidebar Configuration | ||
auto2top: true, | ||
loadSidebar: true, | ||
maxLevel: 0, | ||
// Set subMaxLevel to 0 to remove automatic display of page table of contents (TOC) in Sidebar | ||
subMaxLevel: 3, | ||
|
||
// Search Plugin Configuration | ||
search: { | ||
placeholder: "Type to search", | ||
noData: "No matches found.", | ||
// Headline depth, 1 - 6 | ||
depth: 2, | ||
}, | ||
}; | ||
</script> | ||
|
||
<!-- Required --> | ||
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script> | ||
|
||
<!-- Recommended --> | ||
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/zoom-image.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script> | ||
|
||
<script src="//unpkg.com/[email protected]/dist/docsify-mermaid.js"></script> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Example Second Page | ||
|
||
This is an example second page that will appear in the Docsify Sidebar. | ||
|
||
```mermaid | ||
graph LR | ||
A --- B | ||
B-->C[fa:fa-ban forbidden] | ||
B-->D(fa:fa-spinner); | ||
``` |