484 lines
13 KiB
Markdown
484 lines
13 KiB
Markdown
---
|
|
no_title_header: true
|
|
headless: true
|
|
description: Welcome to the wiki page for the Hiddify project.
|
|
---
|
|
|
|
# [Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions)
|
|
|
|
!!! note "optional title"
|
|
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
!!! abstract "abstract"
|
|
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
!!! info "info"
|
|
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
!!! tip "tip"
|
|
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
!!! success "success"
|
|
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
!!! question "question"
|
|
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
|
|
!!! warning "warning"
|
|
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
!!! failure "failure"
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
|
|
|
|
|
|
!!! danger "danger"
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
|
|
|
|
!!! bug "bug"
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
|
|
!!! example "example"
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
!!! quote "quote"
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
|
|
??? info "Collapsible info"
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
???+ danger "expanded Collapsible danger"
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
!!! info inline end "inline end info "
|
|
|
|
Lorem ipsum dolor sit amet, consectetur
|
|
adipiscing elit. Nulla et euismod nulla.
|
|
Curabitur feugiat, tortor non consequat
|
|
finibus, justo purus auctor massa, nec
|
|
semper lorem quam in massa.
|
|
|
|
Lorem ipsum dolor sit amet, consectetur
|
|
adipiscing elit. Nulla et euismod nulla.
|
|
Curabitur feugiat, tortor non consequat
|
|
|
|
|
|
|
|
!!! bug inline "inline bug "
|
|
|
|
Lorem ipsum dolor sit amet, consectetur
|
|
adipiscing elit. Nulla et euismod nulla.
|
|
Curabitur feugiat, tortor non consequat
|
|
finibus, justo purus auctor massa, nec
|
|
semper lorem quam in massa.
|
|
|
|
Lorem ipsum dolor sit amet, consectetur
|
|
adipiscing elit. Nulla et euismod nulla.
|
|
Curabitur feugiat, tortor non consequat
|
|
Lorem ipsum dolor sit amet, consectetur
|
|
adipiscing elit. Nulla et euismod nulla.
|
|
Curabitur feugiat, tortor non consequat
|
|
Lorem ipsum dolor sit amet, consectetur
|
|
adipiscing elit. Nulla et euismod nulla.
|
|
Curabitur feugiat, tortor non consequat
|
|
Lorem ipsum dolor sit amet, consectetur
|
|
adipiscing elit. Nulla et euismod nulla.
|
|
Curabitur feugiat, tortor non consequat
|
|
Lorem ipsum dolor sit amet, consectetur
|
|
adipiscing elit. Nulla et euismod nulla.
|
|
Curabitur feugiat, tortor non consequat
|
|
|
|
|
|
|
|
|
|
|
|
# [Annotations](https://squidfunk.github.io/mkdocs-material/reference/annotations/)
|
|
|
|
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
|
|
{ .annotate }
|
|
|
|
1. :man_raising_hand: I'm an annotation!
|
|
|
|
|
|
## Annotation in Tab
|
|
|
|
=== "Tab 1"
|
|
|
|
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
|
|
{ .annotate }
|
|
|
|
1. :man_raising_hand: I'm an annotation!
|
|
|
|
=== "Tab 2"
|
|
|
|
Phasellus posuere in sem ut cursus (1)
|
|
{ .annotate }
|
|
|
|
1. :woman_raising_hand: I'm an annotation as well!
|
|
|
|
## [Footnote](https://squidfunk.github.io/mkdocs-material/reference/footnotes/#fn:1)
|
|
Lorem ipsum[^1] dolor sit amet, consectetur adipiscing elit.[^2]
|
|
[^1]: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
|
[^2]:
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
|
|
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
|
|
massa, nec semper lorem quam in massa.
|
|
|
|
## [Button](https://squidfunk.github.io/mkdocs-material/reference/buttons/)
|
|
|
|
[Subscribe to our newsletter](#){ .md-button }
|
|
|
|
[Send :fontawesome-solid-paper-plane:](#){ .md-button }
|
|
|
|
[Subscribe to our newsletter](#){ .md-button .md-button--primary }
|
|
|
|
|
|
## [Code Block](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/)
|
|
|
|
``` py title="bubble_sort.py"
|
|
def bubble_sort(items):
|
|
for i in range(len(items)):
|
|
for j in range(len(items) - 1 - i):
|
|
if items[j] > items[j + 1]:
|
|
items[j], items[j + 1] = items[j + 1], items[j] # (1)!
|
|
```
|
|
|
|
1. Annotate should be in comment section! # for bash and yaml and // for java
|
|
|
|
|
|
|
|
## [Tabs](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#grouping-code-blocks-c_1)
|
|
|
|
### Tabs in block
|
|
|
|
!!! example "tabs in block"
|
|
|
|
=== "Unordered List"
|
|
|
|
``` markdown
|
|
* Sed sagittis eleifend rutrum
|
|
* Donec vitae suscipit est
|
|
* Nulla tempor lobortis orci
|
|
```
|
|
|
|
=== "Ordered List"
|
|
|
|
``` markdown
|
|
1. Sed sagittis eleifend rutrum
|
|
2. Donec vitae suscipit est
|
|
3. Nulla tempor lobortis orci
|
|
```
|
|
|
|
|
|
|
|
# [Table](https://squidfunk.github.io/mkdocs-material/reference/data-tables/#column-alignment-center)
|
|
|
|
Remove `:` from the second row to align to left or right
|
|
|
|
| Method | Description |
|
|
| :---------: | :----------------------------------: |
|
|
| `GET` | :material-check: Fetch resource |
|
|
| `PUT` | :material-check-all: Update resource |
|
|
| `DELETE` | :material-close: Delete resource |
|
|
|
|
|
|
|
|
## [Diagram](https://squidfunk.github.io/mkdocs-material/reference/diagrams/)
|
|
|
|
|
|
``` mermaid
|
|
graph LR
|
|
A[Start] --> B{Error?};
|
|
B -->|Yes| C[Hmm...];
|
|
C --> D[Debug];
|
|
D --> B;
|
|
B ---->|No| E[Yay!];
|
|
```
|
|
|
|
|
|
``` mermaid
|
|
sequenceDiagram
|
|
autonumber
|
|
Alice->>John: Hello John, how are you?
|
|
loop Healthcheck
|
|
John->>John: Fight against hypochondria
|
|
end
|
|
Note right of John: Rational thoughts!
|
|
John-->>Alice: Great!
|
|
John->>Bob: How about you?
|
|
Bob-->>John: Jolly good!
|
|
```
|
|
|
|
``` mermaid
|
|
stateDiagram-v2
|
|
state fork_state <<fork>>
|
|
[*] --> fork_state
|
|
fork_state --> State2
|
|
fork_state --> State3
|
|
|
|
state join_state <<join>>
|
|
State2 --> join_state
|
|
State3 --> join_state
|
|
join_state --> State4
|
|
State4 --> [*]
|
|
```
|
|
|
|
|
|
``` mermaid
|
|
classDiagram
|
|
Person <|-- Student
|
|
Person <|-- Professor
|
|
Person : +String name
|
|
Person : +String phoneNumber
|
|
Person : +String emailAddress
|
|
Person: +purchaseParkingPass()
|
|
Address "1" <-- "0..1" Person:lives at
|
|
class Student{
|
|
+int studentNumber
|
|
+int averageMark
|
|
+isEligibleToEnrol()
|
|
+getSeminarsTaken()
|
|
}
|
|
class Professor{
|
|
+int salary
|
|
}
|
|
class Address{
|
|
+String street
|
|
+String city
|
|
+String state
|
|
+int postalCode
|
|
+String country
|
|
-validate()
|
|
+outputAsLabel()
|
|
}
|
|
```
|
|
|
|
|
|
|
|
|
|
# [Formatting](https://squidfunk.github.io/mkdocs-material/reference/formatting/)
|
|
|
|
Text can be {--deleted--} and replacement text {++added++}. This can also be
|
|
combined into {~~one~>a single~~} operation. {==Highlighting==} is also
|
|
possible {>>and comments can be added inline<<}.
|
|
|
|
{==
|
|
|
|
Formatting can also be applied to blocks by putting the opening and closing
|
|
tags on separate lines and adding new lines between the tags and the content.
|
|
|
|
==}
|
|
|
|
Text can be {--deleted--} and replacement text {++added++}. This can also be
|
|
combined into {~~one~>a single~~} operation. {==Highlighting==} is also
|
|
possible {>>and comments can be added inline<<}.
|
|
|
|
{==
|
|
|
|
Formatting can also be applied to blocks by putting the opening and closing
|
|
tags on separate lines and adding new lines between the tags and the content.
|
|
|
|
==}
|
|
|
|
- H~2~O
|
|
- A^T^A
|
|
|
|
++ctrl+alt+del++
|
|
|
|
|
|
|
|
## [Grid](https://squidfunk.github.io/mkdocs-material/reference/grids/)
|
|
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- :material-clock-fast:{ .lg .middle } __Set up in 5 minutes__
|
|
|
|
---
|
|
|
|
Install [`mkdocs-material`](#) with [`pip`](#) and get up
|
|
and running in minutes
|
|
|
|
[:octicons-arrow-right-24: Getting started](#)
|
|
|
|
- :fontawesome-brands-markdown:{ .lg .middle } __It's just Markdown__
|
|
|
|
---
|
|
|
|
Focus on your content and generate a responsive and searchable static site
|
|
|
|
[:octicons-arrow-right-24: Reference](#)
|
|
|
|
- :material-format-font:{ .lg .middle } __Made to measure__
|
|
|
|
---
|
|
|
|
Change the colors, fonts, language, icons, logo and more with a few lines
|
|
|
|
[:octicons-arrow-right-24: Customization](#)
|
|
|
|
- :material-scale-balance:{ .lg .middle } __Open Source, MIT__
|
|
|
|
---
|
|
|
|
Material for MkDocs is licensed under MIT and available on [GitHub]
|
|
|
|
[:octicons-arrow-right-24: License](#)
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="grid" markdown>
|
|
|
|
=== "Unordered list"
|
|
|
|
* Sed sagittis eleifend rutrum
|
|
* Donec vitae suscipit est
|
|
* Nulla tempor lobortis orci
|
|
|
|
=== "Ordered list"
|
|
|
|
1. Sed sagittis eleifend rutrum
|
|
2. Donec vitae suscipit est
|
|
3. Nulla tempor lobortis orci
|
|
|
|
``` title="Content tabs"
|
|
=== "Unordered list"
|
|
|
|
* Sed sagittis eleifend rutrum
|
|
* Donec vitae suscipit est
|
|
* Nulla tempor lobortis orci
|
|
|
|
=== "Ordered list"
|
|
|
|
1. Sed sagittis eleifend rutrum
|
|
2. Donec vitae suscipit est
|
|
3. Nulla tempor lobortis orci
|
|
```
|
|
|
|
</div>
|
|
|
|
|
|
|
|
# [Icons](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/)
|
|
|
|
Search icons from https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
|
|
|
|
|
|
:smile:
|
|
:fontawesome-regular-face-laugh-wink:
|
|
|
|
|
|
|
|
# [Image](https://squidfunk.github.io/mkdocs-material/reference/images/#image-alignment-left)
|
|
{ align=left }
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
|
|
|
|
|
|
|
|
<figure markdown>
|
|
{ width="300" }
|
|
<figcaption>Image caption</figcaption>
|
|
</figure>
|
|
|
|
|
|
|
|
# [List](https://squidfunk.github.io/mkdocs-material/reference/lists/)
|
|
|
|
1. Vivamus id mi enim. Integer id turpis sapien. Ut condimentum lobortis
|
|
sagittis. Aliquam purus tellus, faucibus eget urna at, iaculis venenatis
|
|
nulla. Vivamus a pharetra leo.
|
|
|
|
1. Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet
|
|
quam enim, eu volutpat urna rutrum a. Nam vehicula nunc mauris, a
|
|
ultricies libero efficitur sed.
|
|
|
|
2. Morbi eget dapibus felis. Vivamus venenatis porttitor tortor sit amet
|
|
rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a.
|
|
|
|
1. Mauris dictum mi lacus
|
|
2. Ut sit amet placerat ante
|
|
3. Suspendisse ac eros arcu
|
|
|
|
|
|
- Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur
|
|
accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh
|
|
lacinia sed. Aenean in finibus diam.
|
|
|
|
* Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
|
|
* Nam vulputate tincidunt fringilla.
|
|
* Nullam dignissim ultrices urna non auctor.
|
|
|
|
|
|
|
|
- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit
|
|
- [ ] Vestibulum convallis sit amet nisi a tincidunt
|
|
* [x] In hac habitasse platea dictumst
|
|
* [x] In scelerisque nibh non dolor mollis congue sed et metus
|
|
* [ ] Praesent sed risus massa
|
|
- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque
|
|
|
|
|