Skip to content

Commit bc6b259

Browse files
committed
use mm-docs 0.8; use variable as app name; add dark theme; many small fixes
1 parent 19386f0 commit bc6b259

13 files changed

+44
-107
lines changed

docs.build.ps1

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#>
44
param (
55
# Version/tag of the mm-docs image to use
6-
[string] $aVersion = (property MM_DOCS_VERSION '0.7.6'),
6+
[string] $aVersion = (property MM_DOCS_VERSION '0.8'),
77

88
# Registry and name to use to get mm-docs image
99
[string] $aImageName = (property MM_DOCS_IMAGE_NAME 'majkinetor/mm-docs'),

source/docs/about.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,15 @@ hide: [navigation]
77

88
Hi there,
99

10-
I’m Shawn. the author of 1Remote. I’m a software developer from China, a big fan of remote desktop software, user of C++/C/C#/Python/Pytorch/Go/typescript. I’m also a big fan of open source software. I hope that 1Remote can help you manage your remote connections well and find this app useful. If you would like to support my work, you can buy me a coffee or give a nice review. Thanks!
10+
I’m Shawn. the author of {{appname}}. I’m a software developer from China, a big fan of remote desktop software, user of C++/C/C#/Python/Pytorch/Go/typescript. I’m also a big fan of open source software. I hope that 1Remote can help you manage your remote connections well and find this app useful. If you would like to support my work, you can buy me a coffee or give a nice review. Thanks!
1111

1212
- [Buy a coffee](https://ko-fi.com/VShawn)
1313
- [Buy a copy on Microsoft Store](https://www.microsoft.com/store/productId/9PNMNF92JNFP)
1414
- [请杯咖啡](https://raw.githubusercontent.com/1Remote/PRemoteM/Doc/DocPic/others/donate.jpg)
1515

1616
If you have any questions/suggestions please feel free to let me know. [[email protected]](mailto:[email protected]) is my email in case you want to contact me.
1717

18-
19-
## Make 1Remote Stronger
18+
## Make {{appname}} Stronger
2019

2120
If you like this app, please help us make it stronger by doing any of the following:
2221

source/docs/download.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Latest Version: 0.7.2.8
1717
## Installation
1818

1919
!!! note
20-
- The exe version of 1Remote on GitHub is **completely free** for personal use.
20+
- The exe version of {{appname}} on GitHub is **completely free** for personal use.
2121
- For Microsoft Store build, you may need to pay for a lifetime license.
2222

23-
| | 1Remote <br/> Preview build | Old PRemoteM <br/> Stable EXE build | Old PRemoteM <br/> Microsoft Store build |
23+
| | {{appname}} <br/> Preview build | Old PRemoteM <br/> Stable EXE build | Old PRemoteM <br/> Microsoft Store build |
2424
| :------------- | :----------------------------------------------------------------------------: | :--------------------------------------------------------: | :-----------------------------------------------------------------------: |
2525
| Auto update || ⛔ <br/> You have to update it manually | ✅ <br/> You can update it from store or WinGet |
2626
| Other features | ✅ + 💥New Features |||

source/docs/index copy.md

-33
This file was deleted.

source/docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
22
template: home.html
33
title: Home
4+
hide: footer
45
---

source/docs/pricing.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ hide: [toc, navigation]
55
# Pricing
66

77
!!! note
8-
- The exe version of 1Remote on GitHub is **completely free** for personal use.
8+
- The exe version of {{appname}} on GitHub is **completely free** for personal use.
99
- For Microsoft Store build, you may need to pay for a lifetime license.
1010
- We will give away free lifetime license for some special events.
11-
- For commercial use, I am not currently considering charging for commercial licensing of 1Remote, so you can use it in your company, but I will not provide any support for commercial use.
11+
- For commercial use, I am not currently considering charging for commercial licensing of {{appname}}, so you can use it in your company, but I will not provide any support for commercial use.
1212

1313
All features are available on all this versions. *Microsoft Store version may introduce some unique new features in the future.*
1414

15-
| features | EXE build | Microsoft Store build |
15+
| Features | EXE build | Microsoft Store build |
1616
| ----------------- | ---------------------------------- | ------------------------------- |
1717
| Update by one key | ⛔ You have to update it manually | ✅ You can update it from store |
1818
| Other features |||
@@ -22,10 +22,10 @@ All features are available on all this versions. *Microsoft Store version may in
2222
If you are:
2323

2424
- our donator
25-
- contributor of 1Remote
25+
- contributor of {{appname}}
2626

27-
Please contact us at [[email protected]](mailto:[email protected]), I will send you some free licenses💖.
27+
Please contact us at [[email protected]], I will send you some free licenses💖.
2828

29-
Feel free to contact me if you have any questions for these [[email protected]](mailto:[email protected]).
29+
Feel free to contact me if you have any questions for these [[email protected]].
3030

3131
{% include 'footer.md' %}

source/docs/privacy-policy.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ hide: [navigation]
33
---
44
# Privacy Policy
55

6-
[VShawn](https://github.com/VShawn) built this app as an Open Source app. This SERVICE is provided by VShawn at no cost with exe published and is intended for use as is.
6+
[VShawn] built this app as an Open Source app. This SERVICE is provided by VShawn at no cost with exe published and is intended for use as is.
77

88
This page is used to inform visitors regarding my policies with the collection, use, and disclosure of Personal Information if anyone decided to use my Service.
99

1010
If you choose to use my Service, then you agree to the collection and use of information in relation to this policy. The Personal Information that I collect is used for providing and improving the Service. I will not use or share your information with anyone except as described in this Privacy Policy.
1111

12-
The terms used in this Privacy Policy have the same meanings as in our Terms and Conditions, which is accessible at 1Remote unless otherwise defined in this Privacy Policy.
12+
The terms used in this Privacy Policy have the same meanings as in our Terms and Conditions, which is accessible at {{appname}} unless otherwise defined in this Privacy Policy.
1313

1414
## Information Collection and Use
1515

source/docs/usage/database/security.md

+4-24
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,20 @@
22
33
## Security
44

5-
Since 1Remote is designed for snappy and fast experience, it is not easy to make a balance between convenience and safety. Since users are probably IT people with high security awareness, we decided to pay more attention to convenience, leaving security to the system, security software, and good user habits to protect. Therefore, we will only provide the most basic information security, and will not provide functions such as activation lock.
5+
Since {{appname}} is designed for snappy and fast experience, it is not easy to make a balance between convenience and safety. Since users are probably IT people with high security awareness, we decided to pay more attention to convenience, leaving security to the system, security software, and good user habits to protect. Therefore, we will only provide the most basic information security, and will not provide functions such as activation lock.
66

7-
### Why 1Remote don't need a activation password
7+
### Why {{appname}} doesn't need a activation password
88

9-
Since this program is a resident background app that starts a session through the launcher (Alt + M). If you have to enter a password every time you turn on the launcher, the experience will be greatly reduced. Or if the password is only required when the program is started, then the security cannot actually be properly guaranteed. Taking these into account, we believe that it is bette for security guaranteed by the system, security software, and good user habits in long-term solution. As long as the user realizes that he should lock the system when he/she leaves the computer, 1Remote does not have to put add any activation protect.And if the user does not have such security awareness, then even if we adds the activation password, the information may still be leaked through other ways.
9+
Since this program is a resident background app that starts a session through the launcher (Alt + M). If you have to enter a password every time you turn on the launcher, the experience will be greatly reduced. Or if the password is only required when the program is started, then the security cannot actually be properly guaranteed. Taking these into account, we believe that it is better for security guaranteed by the system, security software, and good user habits in long-term solution. As long as the user realizes that he should lock the system when he/she leaves the computer, 1Remote does not have to put add any activation protect.And if the user does not have such security awareness, then even if we adds the activation password, the information may still be leaked through other ways.
1010

1111
### What we provide
1212

13-
For the data sync / sharing reason, 1Remote only provide a basic string encryption in database (account, password, etc.). So it is recommended to enable hard disk encryption (like [Bitlocker](https://docs.microsoft.com/en-us/windows/security/information-protection/)) to ensure that event when the 1Remote database is leaked or the hard disk is cracked physically, the theft will get nothings.
13+
For the data sync / sharing reason, {{appname}} only provide a basic string encryption in database (account, password, etc.). So it is recommended to enable hard disk encryption (like [Bitlocker](https://docs.microsoft.com/en-us/windows/security/information-protection/)) to ensure that event when the {{appname}} database is leaked or the hard disk is cracked physically, the theft will get nothings.
1414

1515
## Summary
1616

1717
- Lock Windows when you left your computer.
1818
- Backup your data frequently.
1919
- (Recommended) Enabled bitLocker.
2020

21-
## 简体中文
22-
23-
### 信息安全
24-
25-
1Remote 设计的初衷在于希望用户能随时随地快速地开启新的远程会话,于是我们很难平衡便利性与安全性。考虑到 1Remote 的使用群体应当是对计算机安全有一定认知的业内人士,于是我们决定更多关注于**便利性**,而将安全性交给系统、安全软件、良好的用户习惯来保护。因此 1Remote 将只提供最基本的信息安全保障,不提供类似于启动密码之类的功能。
26-
27-
#### 为何没有做开机密码?
28-
29-
由于本程序是一个常驻后台,通过启动器(Alt + M)启动会话的远程管理工具,如果每次开启启动器都要输入密码,那么使用体验将大打折扣。而如果仅在程序启动时要求密码,那么安全性其实并未能够得到妥善保障。考虑到这些,我们认为安全性由系统、安全软件、良好的用户习惯保障才是长远之计。只要用户意识到在自己离开计算机时应当锁定系统,那么 1Remote 就不必为自己再加一层枷锁。而若用户没有这样的安全意识,那么就算 1Remote 加入了启动密码,信息仍有可能从其他方式被泄露。
30-
31-
#### 我们提供的加密功能
32-
33-
考虑到数据同步、共享等因素,我们只提供了数据库的中基础数据的加密功能(账号、密码等)这并不完全保险,推荐开启硬盘加密(like [Bitlocker](https://docs.microsoft.com/en-us/windows/security/information-protection/)) 。以确保即便 1Remote 数据库被泄露,或计算机硬盘遭到物理破解时,盗窃者依旧无法获取到其中的机密。
34-
35-
#### 总结
36-
37-
- 确保每次离开电脑后,系统都会被锁。
38-
- (**推荐**) 开启 BitLocker in Windows 10。
39-
4021
{% include 'footer.md' %}
41-

source/docs/usage/overview.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -72,22 +72,22 @@ When some servers are selected, **`Export`** button can export selected items to
7272

7373
Since PRemoteM is our old name, you can also import data from PRemoteM.
7474

75-
Our migration tool will auto detect your old data when your first start 1Remote.
75+
Our migration tool will auto detect your old data when your first start {{appname}}.
7676

7777
![prm](/usage/img/migrate-tools-for-prm.jpg)
7878

7979
If the you miss the auto-migration, you can still import it manually:
8080

8181
1. In PRemoteM export all data following the [Data export](#data-export) guide, you will get a *.prma file.
82-
2. In 1Remote click the **`+`** button in the upper-right corner then click the **`Import`** button, select the *.prma file you just exported in the pop-up dialog by select the file filter \*\.\*, and click "Open" to complete the import.
82+
2. In {{appname}} click the **`+`** button in the upper-right corner then click the **`Import`** button, select the *.prma file you just exported in the pop-up dialog by select the file filter \*\.\*, and click "Open" to complete the import.
8383

8484
#### Importing from RDP Files
8585

8686
!!! warning inline end
8787
We are not able to get password form RDP file, so you may have to enter password manually.
8888

8989
1. In MSTSC.exe, click "Show Options" to expand the window, click the **`Save As...`** button under "Connection settings", and save as an RDP file.
90-
2. In 1Remote, click the **`+`** button in the upper-right corner of the main window, and choose "**import *.rdp**". Select the RDP file you just saved in the pop-up dialog, and click "Open" to complete the import.
90+
2. In {{appname}}, click the **`+`** button in the upper-right corner of the main window, and choose "**import *.rdp**". Select the RDP file you just saved in the pop-up dialog, and click "Open" to complete the import.
9191

9292
## Starting Remote Connections
9393

source/docs/usage/quick-start.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
# {{name}} Quick Start
1+
# {{appname}} Quick Start
22

33
![logo](img/p2o.png)
44

5-
> {{name}} is the upgraded version of PRemoteM.
6-
> {{name}} is open source and free to use.
5+
!!! info "PRemoteM vs {{appname}}"
6+
{{appname}} is the upgraded version of PRemoteM.
7+
8+
{{appname}} is open source and free to use.
79

810
## Installation
911

source/inc/footer.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{% include 'abbr.md' %}
22
{% include 'docinfo.md' %}
3-
{% include 'analytics.md' %}
3+
{% include 'analytics.md' %}
4+
{% include 'links.md' %}

source/inc/links.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
[VShawn]: https://github.com/VShawn

source/mkdocs.yml

+14-29
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,31 @@ edit_uri: https://github.com/1Remote/1Remote.github.io/edit/main/source/docs
88

99
dev_addr: 127.0.0.1:8000
1010

11-
hide:
12-
# - navigation
13-
- toc
1411
theme:
1512
custom_dir: overrides
1613
icon:
1714
logo: material/library-shelves
1815
favicon: img/logo.png
1916
logo: img/logo.png
2017
features:
21-
# - navigation.expand
2218
- navigation.instant # now behaves like a Single Page Application
2319
- navigation.top # Back-to-top button
2420
- navigation.indexes # documents can be directly attached to sections, which is particularly useful for providing overview pages: https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#with-section-index-pages
2521
- header.autohide
2622
- navigation.tabs
27-
# - navigation.tabs.sticky # tab will not auto hide
2823
- navigation.sections
2924
- navigation.tracking
25+
- navigation.footer
3026
name: material
31-
# palette:
32-
# - scheme: default
33-
# toggle:
34-
# icon: material/lightbulb-outline
35-
# name: Switch to dark mode
36-
# - scheme: slate
37-
# toggle:
38-
# icon: material/lightbulb
39-
# name: Switch to light mode
40-
41-
palette: # https://www.materialpalette.com/colors
27+
palette:
4228
- scheme: default
43-
#primary: "teal" # comment to replace by /docs/css/extra.css
44-
accent: red
45-
# toggle:
46-
# icon: material/toggle-switch-off-outline
47-
# name: Switch to dark mode
48-
# - scheme: slate
49-
# #primary: "teal" # comment to replace by /docs/assets/stylesheets
50-
# accent: teal
51-
# toggle:
52-
# icon: material/toggle-switch
53-
# name: Switch to light mode
29+
toggle:
30+
icon: material/lightbulb-outline
31+
name: Switch to dark mode
32+
- scheme: slate
33+
toggle:
34+
icon: material/lightbulb
35+
name: Switch to light mode
5436

5537
extra_css:
5638
- extra/css/extra.css
@@ -68,8 +50,9 @@ extra_javascript:
6850

6951
extra:
7052
url_prefix: !ENV MM_DOCS_URL_PREFIX
71-
name: 1Remote
53+
appname: 1Remote
7254
shortname: 1RM
55+
author:
7356
social:
7457
- icon: fontawesome/brands/github
7558
link: https://github.com/1Remote/
@@ -144,7 +127,9 @@ plugins:
144127
- macros:
145128
include_dir: inc
146129
- search:
147-
language: en # https://squidfunk.github.io/mkdocs-material/usage/#language
130+
separator: '[\s\-\.]+'
131+
lang:
132+
- en
148133
- tags:
149134
tags_file: tags.md
150135
- pdf-export:

0 commit comments

Comments
 (0)