Merge branch 'develop' into patch-1

Author: sy-records

.github/PULL_REQUEST_TEMPLATE.md

@@ -14,6 +14,7 @@
 - [ ] Refactor
 - [ ] Docs
 - [ ] Build-related changes
+- [ ] Repo settings
 - [ ] Other, please describe:
 
 If changing the UI of default theme, please provide the **before/after** screenshot:
@@ -44,11 +45,3 @@ If adding a **new feature**, the PR's description includes:
 - [ ] Related tests have been updated
 
 To avoid wasting your time, it's best to open a **feature request issue** first and wait for approval before working on it.
-
-
-**Other information:**
-
----
-
-* [ ] DO NOT include files inside `lib` directory.
-

.gitignore

@@ -2,10 +2,10 @@
 .DS_Store
 .idea
 node_modules
-themes/
-lib/
-cypress/integration/examples
-cypress/fixtures/docs
+/themes/
+/lib/
+/cypress/integration/examples
+/cypress/fixtures/docs
 
 # exceptions
-!.gitkeep
+!.gitkeep

docs/index.html

@@ -92,20 +92,21 @@
         }
       ]
     }
-	</script>
-	<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
-	<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
-	<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/ga.min.js"></script>
-	<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/matomo.min.js"></script>
-	<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
-	<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-markdown.min.js"></script>
-	<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-nginx.min.js"></script>
-	<script>
-		((window.gitter = {}).chat = {}).options = {
-      room: 'docsifyjs/Lobby'
-    };
-	</script>
-	<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
+  </script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/ga.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/matomo.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-markdown.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-nginx.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-php.min.js"></script>
+  <script>
+  ((window.gitter = {}).chat = {}).options = {
+    room: 'docsifyjs/Lobby'
+  };
+  </script>
+  <script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
 </body>
 
 </html>

docs/language-highlight.md

@@ -1,11 +1,53 @@
-# language highlight
+# Language highlighting
 
-**docsify** uses [Prism](https://github.com/PrismJS/prism) to highlight code blocks in your pages. By default it only supports CSS, JavaScript and HTML. You can make **Prism** load additional languages:
+Docsify uses [Prism](https://prismjs.com) to highlight code blocks in your pages. Prism supports the following languages by default:
+
+* Markup - `markup`, `html`, `xml`, `svg`, `mathml`, `ssml`, `atom`, `rss`
+* CSS - `css`
+* C-like - `clike`
+* JavaScript - `javascript`, `js`
+
+Support for [additional languages](https://prismjs.com/#supported-languages) is available by loading the language-specific [grammar files](https://cdn.jsdelivr.net/npm/prismjs@1/components/) via CDN:
 
 ```html
-<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
-<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
-<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-php.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script>
 ```
 
-?> Check the [component files](https://github.com/PrismJS/prism/tree/gh-pages/components) list for more options.
+To enable syntax highlighting, wrap each code block in triple backticks with the [language](https://prismjs.com/#supported-languages) specified on the first line:
+
+````
+```html
+<p>This is a paragraph</p>
+<a href="//docsify.js.org/">Docsify</a>
+```
+
+```bash
+echo "hello"
+```
+
+```php
+function getAdder(int $x): int 
+{
+    return 123;
+}
+```
+````
+
+The above markdown will be rendered as:
+
+```html
+<p>This is a paragraph</p>
+<a href="//docsify.js.org/">Docsify</a>
+```
+
+```bash
+echo "hello"
+```
+
+```php
+function getAdder(int $x): int 
+{
+    return 123;
+}
+```

docs/more-pages.md

@@ -51,6 +51,18 @@ Create the `_sidebar.md`:
 
 You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
 
+!> Docsify only looks for `_sidebar.md` in the current folder, and uses that, otherwise it falls back to the one configured using `window.$docsify.loadSidebar` config.
+
+Example file structure:
+
+```text
+└── docs/
+    ├── _sidebar.md
+    ├── index.md
+    ├── getting-started.md
+    └── running-services.md
+```
+
 ## Nested Sidebars
 
 You may want the sidebar to update with only navigation to reflect the current directory. This can be done by adding a `_sidebar.md` file to each folder.