Merge pull request #29 from laosb/new-docs

WIP New docs site

Readme.md

@@ -8,7 +8,7 @@
 [![996.icu](https://img.shields.io/badge/link-996.icu-red.svg)](https://996.icu)
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FM2Team%2FNSudo.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FM2Team%2FNSudo?ref=badge_shield)
 
-![Screenshot](Screenshot.png)
+![Screenshot](docs-src/Screenshot.png)
 
 - Languages
  - [English](Readme.md)
@@ -37,32 +37,32 @@
 - Contact
  - [E-mail](mailto:[email protected])
 
-
 ## About
 
 ### Prototype
 
-NSudo is based on SuperCMD by Raymai97. Visit 
-[here](http://bbs.pcbeta.com/viewthread-1508863-1-1.html "here") for more 
+NSudo is based on SuperCMD by Raymai97. Visit
+[here](http://bbs.pcbeta.com/viewthread-1508863-1-1.html "here") for more
 information about SuperCMD.
 
 ### Third-party introduction
+
 - MajorGeeks: https://www.majorgeeks.com/files/details/nsudo.html
 - softpedia.com: https://www.softpedia.com/get/Tweak/System-Tweak/NSudo.shtml
 - TrishTech.com: https://www.trishtech.com/2018/11/nsudo-run-programs-with-full-privileges-in-windows/
 - Wilders Security Forums: https://www.wilderssecurity.com/threads/396818
 
 ### System requirements
+
 - Supported OS Version: Windows NT 6.0 or later
 - Supported CPU Architecture: x86, x86-64(AMD64), ARM, ARM64
 
-
 ## Usage
 
 ### Quick Start
 
-Please go to the [CPU Architecture] folder and click NSudo.exe. Follow the 
-prompts. For example, if you want to use 64-bit NSudo on your Intel or AMD 
+Please go to the [CPU Architecture] folder and click NSudo.exe. Follow the
+prompts. For example, if you want to use 64-bit NSudo on your Intel or AMD
 device, you need to go to the x64 folder and click NSudoG.exe
 
 ### Command Line
@@ -81,11 +81,11 @@ Available options:
  D Current Process (Drop right)
 PS: This is a mandatory parameter.
 
--P:[ Option ] Create a process with specified privilege option. 
+-P:[ Option ] Create a process with specified privilege option.
 Available options:
  E Enable All Privileges
  D Disable All Privileges
-PS: If you want to use the default privileges to create a process, please do 
+PS: If you want to use the default privileges to create a process, please do
 not include the "-P" parameter.
 
 -M:[ Option ] Create a process with specified Integrity Level option.
@@ -94,7 +94,7 @@ Available options:
  H High
  M Medium
  L Low
-PS: If you want to use the default Integrity Level to create a process, please 
+PS: If you want to use the default Integrity Level to create a process, please
 do not include the "-M" parameter.
 
 -Priority:[ Option ] Create a process with specified [rocess priority option.
@@ -114,7 +114,7 @@ Available options:
  Hide
  Maximize
  Minimize
-PS: If you want to use the default window mode to create a process, please do 
+PS: If you want to use the default window mode to create a process, please do
 not include the "-ShowWindowMode" parameter.
 
 -Wait Make NSudo wait for the created process to end before exiting.
@@ -125,7 +125,7 @@ PS: If you want to use the NSudo's current directory, please do not include the
 "-CurrentDirectory" parameter.
 
 -UseCurrentConsole Create a process with the current console window.
-PS: If you want to create a process with the new console window, please do not 
+PS: If you want to create a process with the new console window, please do not
 include the "-UseCurrentConsole" parameter.
 
 -Version Show version information of NSudo.
@@ -136,34 +136,34 @@ include the "-UseCurrentConsole" parameter.
 
 Context Menu:
  -Install Copy NSudo to the Windows directory and add the context menu.
- -Uninstall Remove NSudo in the Windows directory and the context menu. 
+ -Uninstall Remove NSudo in the Windows directory and the context menu.
 
 PS:
  1. All NSudo command arguments is case-insensitive.
  2. You can use the "/" or "--" override "-" and use the "=" override ":" in
- the command line parameters. For example, "/U:T" and "-U=T" are 
+ the command line parameters. For example, "/U:T" and "-U=T" are
  equivalent.
  3. To ensure the best experience, NSudoC does not support context menu.
 
 Example:
- If you want to run Command Prompt with TrustedInstaller, enable all 
+ If you want to run Command Prompt with TrustedInstaller, enable all
  privileges and the default Integrity Level.
  NSudo -U:T -P:E cmd
 ```
 
-Example：If you want to run Command Prompt with TrustedInstaller, enable all 
+Example：If you want to run Command Prompt with TrustedInstaller, enable all
 privileges and the default Integrity Level:
 
 > NSudo -U:T -P:E cmd
 
-Starting from NSudo 5.0.1708.16, the command line nested quotes is supported. 
-For example: 
+Starting from NSudo 5.0.1708.16, the command line nested quotes is supported.
+For example:
 
 > NSudo -U:T cmd /c "dir "C:\Program Files" & pause"
 
 ### Shortcut List
 
-You can edit NSudo.json to custom the Shortcut list, here are the demo 
+You can edit NSudo.json to custom the Shortcut list, here are the demo
 (NSudo.json in the NSudo.exe's folder):
 
 ```
@@ -178,19 +178,20 @@ You can edit NSudo.json to custom the Shortcut list, here are the demo
 }
 ```
 
-
 ## Documents
 
 ### Changelog
 
 **NSudo 7.0.1904.3**
+
 - Update JSON for Modern C++ to 3.5.0.
 - Use FILE instead of std::ifstream to reduce the memory usage and binary size.
 - Merge NSudo.exe to NSudoG.exe.
 - Use new compiler options to reduce the binary size.
 - Update to Visual Studio 2019.
 
 **NSudo 6.2.1812.31**
+
 - Add French translations. (Contributed by Thomas Dubreuil.)
 - Use JSON for Modern C++ instead of RapidJSON to conform to C++17.
 - Improve the GUI experience. (Thanks to Lenny.)
@@ -199,9 +200,10 @@ You can edit NSudo.json to custom the Shortcut list, here are the demo
 - Add Traditional Chinese translations. (Contributed by Luo Yufan.)
 
 **NSudo 6.1.1811.18**
+
 - Merge NSudoC and NSudoG projects to NSudo project.
-- Add VC-LTL 4.0 or later support for NSudo release configuration for ARM and 
- ARM64 and drop the earlier version of VC-LTL support. (Huge thanks to 
+- Add VC-LTL 4.0 or later support for NSudo release configuration for ARM and
+ ARM64 and drop the earlier version of VC-LTL support. (Huge thanks to
  mingkuang.)
 - Add the following options in the command line usage.
  - CurrentDirectory (Suggested by testtest322.)
@@ -216,41 +218,44 @@ You can edit NSudo.json to custom the Shortcut list, here are the demo
 - Improve several implementations.
  - Refactoring the command line parser.
  - Introduce the new frontend of process creation.
- - Using ATL to implement the main window. 
+ - Using ATL to implement the main window.
  - Fix the context menu bug. (Thanks to Thomas Dubreuil.)
 - Update copyright of license.
 - Remove donation link in the documents.
 
 **NSudo 6.0.1804.5**
-- Fix a bug which can cause crash on Windows Vista and Server 2008. 
+
+- Fix a bug which can cause crash on Windows Vista and Server 2008.
  (Thanks to hydra79545.)
-- Share source code with M2-Team UWP projects. (For more information, please 
+- Share source code with M2-Team UWP projects. (For more information, please
  read "https:/Project-Nagisa/Nagisa/blob/master/Changelog.md")
 - Remove useless implementations.
 - Improve the implementation for NSudoStartService function.
 - Use RapidJSON instead of JSON for Modern C++ to reduce the binary size.
 
 **NSudo 6.0.1802.2 v2**
-- Fix always opens a command prompt window after click the run button. 
+
+- Fix always opens a command prompt window after click the run button.
  (Thanks to AeonX.)
 
 **NSudo 6.0.1802.2**
+
 - Fix several bugs and improve several implementations.
 - Add two standalone executable files used in different situations.
  - NSudoC.exe
  - The pure command line version and subsystem setting is "Console".
- - Work well in the console, but it has a black console window if you call 
+ - Work well in the console, but it has a black console window if you call
  it in the non-Console processes.
  - To ensure the best experience, NSudoC does not support context menu.
  - NSudoG.exe
  - The pure command line version and subsystem setting is "Windows"
  - It can run silently, without a black console window.
 - NSudo will show the message via the M2MessageDialog instead of TaskDialog.
  - Reasons
- - NSudo can provide more detail infomation when error because of it have 
+ - NSudo can provide more detail infomation when error because of it have
  vertical scroll bar.
  - You can copy the content in the message dialog.
- - Support using by the Windows Narrator, so you can use CapsLock+H to read 
+ - Support using by the Windows Narrator, so you can use CapsLock+H to read
  the content by the Windows Narrator.
  - The font size is larger than the TaskDialog.
  - Features of M2MessageDialog
@@ -259,15 +264,15 @@ You can edit NSudo.json to custom the Shortcut list, here are the demo
  - You can use the vertical scroll bar and copy the content.
  - The font size is larger than the TaskDialog.
  - You can press Enter to close the message dialog.
- - If you want to use the M2MessageDialog in your project, please download 
+ - If you want to use the M2MessageDialog in your project, please download
  these files in https:/M2Team/NSudo/tree/master/NSudoSDK
  - M2DPIScaling.cpp
  - M2DPIScaling.h
  - M2MessageDialog.cpp
  - M2MessageDialog.h
  - M2MessageDialogResource.h
  - M2MessageDialogResource.rc
-- Remove Traditional Chinese and Japanese translation because the translation 
+- Remove Traditional Chinese and Japanese translation because the translation
  is out of date and I don't know how to use.
 - Update JSON for Modern C++ to 3.0.1.
 - Context Menu
@@ -276,26 +281,31 @@ You can edit NSudo.json to custom the Shortcut list, here are the demo
 - Update the command line help and documents.
 
 **NSudo 6.0.1801.19**
-- Fix the NSudoDuplicateSessionToken function definition bug. 
+
+- Fix the NSudoDuplicateSessionToken function definition bug.
  (Thanks to mingkuang.)
-- Fix bugs that cannot enable full privileges under the graphical interface. 
+- Fix bugs that cannot enable full privileges under the graphical interface.
  (Thanks to abbodi1406.)
 - Fix bugs that cannot use static compile mode when using release configuration
  for x86 and x86-64 (AMD64) without VC-LTL.
 
 **NSudo 5.3.1801.11**
-- Fix a potential bug when NSudo obtaining the System Token. 
+
+- Fix a potential bug when NSudo obtaining the System Token.
  (Thanks to mingkuang.)
-- Provide VC-LTL support for NSudo release configuration for x86 and x86-64 
+- Provide VC-LTL support for NSudo release configuration for x86 and x86-64
  (AMD64). (Thanks to mingkuang.)
  - PS: Compiling NSudo with VC-LTL can reduce the NSudo's binary size.
 - Maintaining documents.
 
 ### Relevant People
+
 Please read [Relevant People](People.md)
 
 ### Code of Conduct
+
 Please read [Code of Conduct](CODE_OF_CONDUCT.md)
 
 ### Contributing to NSudo
+
 Please read [Contributing to NSudo](CONTRIBUTING.md)

docs-src/.vuepress/config.js

@@ -0,0 +1,112 @@
+module.exports = {
+ themeConfig: {
+ base: "/NSudo/",
+ dest: "../docs",
+ repo: "M2Team/NSudo",
+ docsDir: "docs-src",
+ editLinks: true,
+ locales: {
+ "/": {
+ selectText: "Languages",
+ label: "English",
+ editLinkText: "Edit this page on GitHub",
+ serviceWorker: {
+ updatePopup: {
+ message: "New content is available.",
+ buttonText: "Refresh"
+ }
+ },
+ nav: [{ text: "Home", link: "/" }, { text: "Docs", link: "/docs/" }],
+ sidebar: {
+ "/docs/": [
+ "/docs/",
+ {
+ title: "Documents",
+ children: [
+ "/docs/changelog",
+ ["/docs/People", "Relevant People"],
+ "/docs/CODE_OF_CONDUCT",
+ "/docs/CONTRIBUTING"
+ ]
+ }
+ ]
+ }
+ },
+ "/zh-hans/": {
+ selectText: "选择语言",
+ label: "简体中文",
+ editLinkText: "在 GitHub 上编辑此页",
+ serviceWorker: {
+ updatePopup: {
+ message: "发现新内容可用。",
+ buttonText: "刷新"
+ }
+ },
+ nav: [
+ { text: "首页", link: "/zh-hans/" },
+ { text: "文档", link: "/zh-hans/docs/" }
+ ],
+ sidebar: {
+ "/zh-hans/docs/": [
+ "/zh-hans/docs/",
+ {
+ title: "档案",
+ children: [
+ ["/docs/changelog", "更新日志"],
+ ["/docs/People", "相关人士"],
+ ["/docs/CODE_OF_CONDUCT", "贡献者行为准则"],
+ ["/docs/CONTRIBUTING", "向 NSudo 贡献"]
+ ]
+ }
+ ]
+ }
+ },
+ "/zh-hant/": {
+ selectText: "選擇語言",
+ label: "繁體中文",
+ editLinkText: "在 GitHub 上編輯此頁",
+ serviceWorker: {
+ updatePopup: {
+ message: "發現新內容可用。",
+ buttonText: "重載"
+ }
+ },
+ nav: [
+ { text: "主頁", link: "/zh-hant/" },
+ { text: "文獻", link: "/zh-hant/docs/" }
+ ],
+ sidebar: {
+ "/zh-hant/docs/": [
+ "/zh-hans/docs/",
+ {
+ title: "檔案",
+ children: [
+ ["/docs/changelog", "更新日志"],
+ ["/docs/People", "相关人士"],
+ ["/docs/CODE_OF_CONDUCT", "貢獻者行為準則"],
+ ["/docs/CONTRIBUTING", "向 NSudo 貢獻"]
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ locales: {
+ "/": {
+ lang: "en-US",
+ title: "NSudo",
+ description: "A Powerful System Administration Tool"
+ },
+ "/zh-hans/": {
+ lang: "zh-CN",
+ title: "NSudo",
+ description: "一个强大的系统管理工具"
+ },
+ "/zh-hant/": {
+ lang: "zh-TW",
+ title: "NSudo",
+ description: "一個強大的系統管理工具"
+ }
+ }
+};

docs-src/.vuepress/styles/palette.styl

@@ -0,0 +1 @@
+$accentColor = #2c84d0