Skip to content

Commit

Permalink
docs: prepare for v0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
kimlimjustin committed Sep 22, 2021
1 parent da3850f commit d3e3a95
Show file tree
Hide file tree
Showing 43 changed files with 859 additions and 326 deletions.
3 changes: 2 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ src/Lib/**/*
outs/**/*
scripts/*
src/Components/Functions/log.ts
gruntfile.js
gruntfile.js
docs/**/*
3 changes: 2 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ src/Components/Files/File Icon/fileIcon.ts
src/Components/Files/File Operation/open.ts
src/Components/Favorites/favorites.ts
src/Components/Context Menu/contextmenu.ts
src/Components/Files/File Operation/new.ts
src/Components/Files/File Operation/new.ts
*.min.css
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,41 @@
</div>

<p align="center"><span><b>Xplorer</b>, a customizable, modern and cross-platform file explorer.</span></p>
<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>
<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>

---

## What is Xplorer?
![Demo](https://drive.google.com/uc?export=view&id=1SBuUc0BhC49druJwndW2mabS9amTospZ)
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!

![Demo](docs/static/img/Xplorer%20win.png)
Xplorer is a file explorer built from ground-up to be fully customizable and 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.
It also allowed file preview directly inside it, not only pictures or documents, but also videos!

So to summary, Xplorer's features contain:
- Looks modern
- Fully customizable
- Easy to use
- Cross-platform
- File Preview, even videos!
- Most importantly, FOSS, Free and Open Source, which mean you can change components inside if you see fit

- Looks modern
- Easy to use
- Cross-platform
- File Preview, even videos!
- Most importantly, FOSS, Free and Open Source, which mean you can change components inside if you see fit

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/)!

## Features

So to summary, Xplorer's features contain:

- Looks modern
- Easy to use
- Cross-platform
- File Preview, even videos!
- 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

### Installation
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!

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.

### LICENSE

[Apache-2.0](https://github.com/kimlimjustin/xplorer/blob/master/LICENSE)
35 changes: 0 additions & 35 deletions docs/docs/feature/file operation.md

This file was deleted.

35 changes: 0 additions & 35 deletions docs/docs/feature/shortcut.md

This file was deleted.

File renamed without changes.
31 changes: 31 additions & 0 deletions docs/docs/guides/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Launch Xplorer from Terminal

:::info
This feature hasn't optimized yet. It works but it might be laggy. Will be optimized in the feature release.
:::

## Commands

Xplorer CLI:

```bash
xplorer [dir1] [dir2] [dir3]
```

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.

<details>
<summary>
<code>xplorer: command not found</code> error on Windows
</summary>

Firstly, you have to register the command into the system path.

1. Open the `System Properties` on Windows.
2. Click the `Environment Variables` button, it will popup a window.
3. On the table, search for `Path` variable and click on it.
4. Click `Edit` button, it will popup a window.
5. Click `New` button
6. Add `%USERPROFILE%\AppData\Local\Programs\xplorer`

</details>
191 changes: 191 additions & 0 deletions docs/docs/guides/operation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
# Operations

## Copy files

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.

:::info

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:

```
Xplorer command - COPY
~/xplorer
~/test
```

:::

## Copy Location Path

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.

## Cut files

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.

:::info
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:

```
Xplorer command - CUT
E://xplorer
E://test
```

:::

## Delete files

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`.

:::info

- On Windows, this is done by creating a `Trash` folder on `C:` drive and moving the file into it.
- On Linux, this feature is fully integrated with the sytem
- On macOS, this is done by creating a `.local/Trash` folder on `homedir` and moving the file into it.

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.

:::

### Permanently delete

:::danger
Permanently deleted file cannot be restored. Please check again before permanently delete any files.

:::

You can permanently delete a file by:

1. Delete it into `Trash` and right clicking it and click the `Permanent Delete` option
2. Select the file and press `Shift + Del` as shortcut

## New

:::caution Be careful with new file/folder name
Xplorer treats `/` on file name/folder as subdir/subfile
:::

### New file

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.

### New folder

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.

## Open file

You can open a file on default application by double-clicking it or select the file then press `Enter` as shortcut.

### Open in Terminal

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.

### Open in VSCode

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.

## Pin to Sidebar

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.

## Preview file

You can preview a file directly from Xplorer by right-clicking it and click `Preview` otioin or select the file then press `Ctrl+O`.

![Preview Demo](/img/docs/preview.png)

:::info

<details>
<summary>
Files available to preview for now:
</summary>

```json
[
".pdf",
".html",
".docx",
".htm",
".xlsx",
".xls",
".xlsb",
"xls",
".ods",
".fods",
".csv",
".txt",
".py",
".js",
".bat",
".css",
".c++",
".cpp",
".cc",
".c",
".diff",
".patch",
".go",
".java",
".json",
".php",
".ts",
".tsx",
".jsx",
".jpg",
".png",
".gif",
".bmp",
".jpeg",
".jpe",
".jif",
".jfif",
".jfi",
".webp",
".tiff",
".tif",
".ico",
".svg",
".webp",
".mp4",
".webm",
".mpg",
".mp2",
".mpeg",
".mpe",
".mpv",
".ocg",
".m4p",
".m4v",
".avi",
".wmv",
".mov",
".qt",
".flv",
".swf",
".md"
]
```

</details>

:::

## Properties

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.
Available properties for now (will be improved at the next version):

- Size
- File Path
- Created At
- Accesssed At
- Modified At
- Is Hidden

## Rename file/folder

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.
Loading

1 comment on commit d3e3a95

@vercel
Copy link

@vercel vercel bot commented on d3e3a95 Sep 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.