├── .nojekyll
├── LICENSE
├── README.md
├── _sidebar.md
├── index.html
└── second-page.md


/.nojekyll:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/docsifyjs/docsify-template/a309c9faf2e83fb0db8e212edca175b2af4b6b6f/.nojekyll


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2021 docsifyjs
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Docsify Template
 2 | 
 3 | > A simple [Docsify](https://github.com/docsifyjs/docsify/) template for creating Markdown-based documentation sites, with no build process required.
 4 | 
 5 | ## Site Setup
 6 | 
 7 | ### Static Webserver
 8 | 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.
 9 | 
10 | ### GitHub Pages
11 | 
12 | #### Hosting Site
13 | 
14 | To host this template on GitHub Pages do the following:  
15 | 
16 | 1. Log into GitHub if you have not done so already
17 | 2. Tap the **Use this template** button in the upper-right of this GitHub Repository and choose **Create a new repository**
18 | 3. Enter a name for your new Repository and then tap the **Create repository** button
19 | 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
20 | 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
21 | 
22 | #### Editing Content
23 | 
24 | 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.
25 | 
26 | ### Viewing Locally 
27 | Run `npx serve .` (Node.js users) or `python -m http.server 8000` (Python users) in the repo folder to serve run locally.
28 | 
29 | ## Docsify Documentation
30 | 
31 | To learn more about using Docsify, visit https://docsify.js.org.


--------------------------------------------------------------------------------
/_sidebar.md:
--------------------------------------------------------------------------------
1 | - [Read Me](README)
2 | - [Example Second Page](second-page)


--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 | 
 4 | <head>
 5 |   <meta charset="utf-8">
 6 |   <meta name="viewport"
 7 |     content="width=device-width, initial-scale=1, minimum-scale=1.0, shrink-to-fit=no, viewport-fit=cover">
 8 | 
 9 |   <!-- Replace with your own title and description. -->
10 |   <title>Awesome Docsify Site</title>
11 |   <meta name="description" content="An awesome docsify site for publishing some content on the web.">
12 | 
13 |   <!-- Default Theme (see https://docsify.js.org/#/themes) -->
14 |   <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
15 | 
16 | </head>
17 | 
18 | <body>
19 |   <div id="app"></div>
20 | 
21 |   <script>
22 |     // Docsify Configuration (see https://docsify.js.org/#/configuration)
23 |     window.$docsify = {
24 |       name: 'Simple Docsify Template',
25 | 
26 |       // Sidebar Configuration
27 |       auto2top: true,
28 |       loadSidebar: true,
29 |       maxLevel: 0,
30 |       // Set subMaxLevel to 0 to remove automatic display of page table of contents (TOC) in Sidebar
31 |       subMaxLevel: 3,
32 | 
33 |       // Search Plugin Configuration
34 |       search: {
35 |         placeholder: 'Type to search',
36 |         noData: 'No matches found.',
37 |         // Headline depth, 1 - 6
38 |         depth: 2,
39 |       }
40 |     };
41 |   </script>
42 | 
43 |   <!-- Required -->
44 |   <script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
45 | 
46 |   <!-- Recommended -->
47 |   <script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/zoom-image.min.js"></script>
48 |   <script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
49 | 
50 | </body>
51 | </html>
52 | 


--------------------------------------------------------------------------------
/second-page.md:
--------------------------------------------------------------------------------
1 | # Example Second Page
2 | 
3 | This is an example second page that will appear in the Docsify Sidebar.


--------------------------------------------------------------------------------