Skip to content

Commit d3e3a95

Browse files
kimlimjustinkimlimjustin
committed
docs: prepare for v0.1.0
1 parent da3850f commit d3e3a95

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+859
-326
lines changed

‎.eslintignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ src/Lib/**/*
44
outs/**/*
55
scripts/*
66
src/Components/Functions/log.ts
7-
gruntfile.js
7+
gruntfile.js
8+
docs/**/*

‎.prettierignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ src/Components/Files/File Icon/fileIcon.ts
77
src/Components/Files/File Operation/open.ts
88
src/Components/Favorites/favorites.ts
99
src/Components/Context Menu/contextmenu.ts
10-
src/Components/Files/File Operation/new.ts
10+
src/Components/Files/File Operation/new.ts
11+
*.min.css

‎README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,41 @@
33
</div>
44

55
<p align="center"><span><b>Xplorer</b>, a customizable, modern and cross-platform file explorer.</span></p>
6-
<h4 align="center"><span><a href="https://xplorer.vercel.app/community/support/">Support</a></span> • <span><a href="https://github.com/kimlimjustin/xplorer/discussions">Discussion</a></span> • <span><a href="https://xplorer.vercel.app">Documentation</a></span></h4>
6+
<h4 align="center"><span><a href="https://xplorer.vercel.app/community/support/">Supports</a></span> • <span><a href="https://github.com/kimlimjustin/xplorer/discussions">Discussion</a></span> • <span><a href="https://xplorer.vercel.app">Documentation</a></span></h4>
77

88
---
99

1010
## What is Xplorer?
11-
![Demo](https://drive.google.com/uc?export=view&id=1SBuUc0BhC49druJwndW2mabS9amTospZ)
12-
Xplorer is a modern file explorer built from ground-up to be fully customizable and even without customization, it also looks modern! It is cross-platform, built using Electron Technology that allowed our File Explorer to be run not only in Windows, but also Linux and MacOS alike, lthough we haven't tested it in macOS yet (macOS maintainer in need). It also allowed file preview directly inside it, not only pictures or documents, but also videos!
11+
12+
![Demo](docs/static/img/Xplorer%20win.png)
13+
Xplorer is a file explorer built from ground-up to be fully customizable and without customization, it also looks modern!
14+
It is cross-platform, built using Electron Technology that allowed our File Explorer to be run not only in Windows, but also Linux and MacOS alike.
15+
It also allowed file preview directly inside it, not only pictures or documents, but also videos!
1316

1417
So to summary, Xplorer's features contain:
15-
- Looks modern
16-
- Fully customizable
17-
- Easy to use
18-
- Cross-platform
19-
- File Preview, even videos!
20-
- Most importantly, FOSS, Free and Open Source, which mean you can change components inside if you see fit
18+
19+
- Looks modern
20+
- Easy to use
21+
- Cross-platform
22+
- File Preview, even videos!
23+
- Most importantly, FOSS, Free and Open Source, which mean you can change components inside if you see fit
2124

2225
Xplorer is currently on development progress. Suggest improvement on Xplorer [Discussion](https://github.com/kimlimjustin/xplorer/discussions/) or [contribute into it](https://xplorer.vercel.app/community/Contributing/)!
2326

27+
## Features
28+
29+
So to summary, Xplorer's features contain:
30+
31+
- Looks modern
32+
- Easy to use
33+
- Cross-platform
34+
- File Preview, even videos!
35+
- Most importantly, it's Free and Open Source! Which mean you can change components inside if you see fit and you also don't make your wallet go dry
36+
2437
### Installation
25-
Xplorer is still on development progress right now, however, you can download the installer [here](https://drive.google.com/drive/folders/1n3V-bznvXg-lVZS_5UHMQybGIOamlSUE?usp=sharing) or by developing it locally. We will provide binary installer after releasing the alpha version! Stay tuned!
38+
39+
You can access the insider version [here](https://github.com/kimlimjustin/xplorer/releases). Please not that this is not stable yet. Use it on your own risk.
2640

2741
### LICENSE
42+
2843
[Apache-2.0](https://github.com/kimlimjustin/xplorer/blob/master/LICENSE)

‎docs/docs/feature/file operation.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

‎docs/docs/feature/shortcut.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

‎docs/docs/feature/_category_.json renamed to ‎docs/docs/guides/_category_.json

File renamed without changes.

‎docs/docs/guides/cli.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Launch Xplorer from Terminal
2+
3+
:::info
4+
This feature hasn't optimized yet. It works but it might be laggy. Will be optimized in the feature release.
5+
:::
6+
7+
## Commands
8+
9+
Xplorer CLI:
10+
11+
```bash
12+
xplorer [dir1] [dir2] [dir3]
13+
```
14+
15+
Xplorer will open `dir`, `dir2`, `dir3` as tabs on Xplorer. If there's no any dir passed into the command, Xplorer will starts at Home page.
16+
17+
<details>
18+
<summary>
19+
<code>xplorer: command not found</code> error on Windows
20+
</summary>
21+
22+
Firstly, you have to register the command into the system path.
23+
24+
1. Open the `System Properties` on Windows.
25+
2. Click the `Environment Variables` button, it will popup a window.
26+
3. On the table, search for `Path` variable and click on it.
27+
4. Click `Edit` button, it will popup a window.
28+
5. Click `New` button
29+
6. Add `%USERPROFILE%\AppData\Local\Programs\xplorer`
30+
31+
</details>

‎docs/docs/guides/operation.md

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
# Operations
2+
3+
## Copy files
4+
5+
You can copy files by right clicking it and click `Copy` option or select the file then press `Ctrl + C` as shortcut and paste it by clicking `Paste` option or press `Ctrl + V` on the destination folder.
6+
7+
:::info
8+
9+
On windows and macOS, Xplorer will copy the file paths into local clipboard, because of this, you can copy file from Xplorer and paste it into an folder in another system. However, on Linux, we create a string of Xplorer commands and copy it into user clipboard, Xplorer will read user's clipboard when pasting file (because we haven't found any idea to implement it, fell free to [open a PR](/community/Contributing/#pull-requests) if you can help us). The string of Xplorer command look like this:
10+
11+
```
12+
Xplorer command - COPY
13+
~/xplorer
14+
~/test
15+
```
16+
17+
:::
18+
19+
## Copy Location Path
20+
21+
You can copy a file/folder location path into your clipboard by right clicking it and click `Copy Location Path` or select the file then press `Alt + Shift + C` as shortcut.
22+
23+
## Cut files
24+
25+
You can cut files by right clicking it and click `Cut` option or select the file then press `Ctrl + X` as shortcut and paste it by clicking `Paste` option or press `Ctrl + V` on the destination folder.
26+
27+
:::info
28+
THis is done by creating a string of Xplorer command and copy it into user clipboard to be used when pasting file (not integrated with platform because we haven't found any idea, fell free to [open a PR](/community/Contributing/#pull-requests) if you can help us.). The string og Xplorer command look like this:
29+
30+
```
31+
Xplorer command - CUT
32+
E://xplorer
33+
E://test
34+
```
35+
36+
:::
37+
38+
## Delete files
39+
40+
You can cut files by right clicking it and click `Delete` option or select the file then press `Del` as shortcut. Trashed file can be accessed at `xplorer://Trash`.
41+
42+
:::info
43+
44+
- On Windows, this is done by creating a `Trash` folder on `C:` drive and moving the file into it.
45+
- On Linux, this feature is fully integrated with the sytem
46+
- On macOS, this is done by creating a `.local/Trash` folder on `homedir` and moving the file into it.
47+
48+
We are still working on Windows on macOS to integrate the `Trash` folder, will be released before the stable version came out. fell free to [open a PR](/community/Contributing/#pull-requests) if you can help us.
49+
50+
:::
51+
52+
### Permanently delete
53+
54+
:::danger
55+
Permanently deleted file cannot be restored. Please check again before permanently delete any files.
56+
57+
:::
58+
59+
You can permanently delete a file by:
60+
61+
1. Delete it into `Trash` and right clicking it and click the `Permanent Delete` option
62+
2. Select the file and press `Shift + Del` as shortcut
63+
64+
## New
65+
66+
:::caution Be careful with new file/folder name
67+
Xplorer treats `/` on file name/folder as subdir/subfile
68+
:::
69+
70+
### New file
71+
72+
You can create a new file by right clicking the workspace, expand the `New` option and select `file` option or press `Alt + N` as shortcut.
73+
74+
### New folder
75+
76+
You can create a new folder by right clicking the workspace, expand the `New` option and select `folder` option or press `Shift + N` as shortcut.
77+
78+
## Open file
79+
80+
You can open a file on default application by double-clicking it or select the file then press `Enter` as shortcut.
81+
82+
### Open in Terminal
83+
84+
This is built-in function by Xplorer. You can open a folder on Terminal by right clicking it and click `Open in terminal` option or select the folder then press `Alt + T` as shortcut.
85+
86+
### Open in VSCode
87+
88+
This is built-in function by Xplorer. You can open a file/folder on VSCode by right clicking it and click `Open in vscode` option or select the file then press `Ctrl + Enter` as shortcut. You won't able to do this if you don't have VSCode installed.
89+
90+
## Pin to Sidebar
91+
92+
You can pin a file/folder into sidebar by right clicking it and click `Pin to Sidebar` or select the file then press `Alt + P` as shortcut.
93+
94+
## Preview file
95+
96+
You can preview a file directly from Xplorer by right-clicking it and click `Preview` otioin or select the file then press `Ctrl+O`.
97+
98+
![Preview Demo](/img/docs/preview.png)
99+
100+
:::info
101+
102+
<details>
103+
<summary>
104+
Files available to preview for now:
105+
</summary>
106+
107+
```json
108+
[
109+
".pdf",
110+
".html",
111+
".docx",
112+
".htm",
113+
".xlsx",
114+
".xls",
115+
".xlsb",
116+
"xls",
117+
".ods",
118+
".fods",
119+
".csv",
120+
".txt",
121+
".py",
122+
".js",
123+
".bat",
124+
".css",
125+
".c++",
126+
".cpp",
127+
".cc",
128+
".c",
129+
".diff",
130+
".patch",
131+
".go",
132+
".java",
133+
".json",
134+
".php",
135+
".ts",
136+
".tsx",
137+
".jsx",
138+
".jpg",
139+
".png",
140+
".gif",
141+
".bmp",
142+
".jpeg",
143+
".jpe",
144+
".jif",
145+
".jfif",
146+
".jfi",
147+
".webp",
148+
".tiff",
149+
".tif",
150+
".ico",
151+
".svg",
152+
".webp",
153+
".mp4",
154+
".webm",
155+
".mpg",
156+
".mp2",
157+
".mpeg",
158+
".mpe",
159+
".mpv",
160+
".ocg",
161+
".m4p",
162+
".m4v",
163+
".avi",
164+
".wmv",
165+
".mov",
166+
".qt",
167+
".flv",
168+
".swf",
169+
".md"
170+
]
171+
```
172+
173+
</details>
174+
175+
:::
176+
177+
## Properties
178+
179+
You can view properties of a file/folder by right clicking it and click `Properties` or select the file then press `Ctrl + P` as shortcut.
180+
Available properties for now (will be improved at the next version):
181+
182+
- Size
183+
- File Path
184+
- Created At
185+
- Accesssed At
186+
- Modified At
187+
- Is Hidden
188+
189+
## Rename file/folder
190+
191+
You can rename a file/folder by right clicking it and click `Rename` option or select the file then press `F2` as shortcut. It will prompt a dialog, enter the new name and the file/folder will be renamed.

0 commit comments

Comments
 (0)