@samitouri / QOSami-HFS-1 / commits / a76ab77a

doc: fixed broken links

Massimo Melina committed Dec 20, 2025 at 19:05 UTC a76ab77afbf7cc646a2bc8dd8f361a48fa1f1f35
2 files changed +18 -19
README.md
+11 -12
@@ -4,16 +4,16 @@
4
5 ## Introduction
6
7 -Access via web your files directly from your disk.
7 +Access your files via web, directly from your disk.
8
9 -- Be your own server, share files **fresh from your disk**, with **unlimited** space and bandwidth.
10 -- **Fast:** try zipping 100GB, download starts immediately.
11 -- **Smart:** HFS tries to detect problems and suggest solutions.
9 +- Be your own server: share files **fresh from your disk** with **unlimited** space and bandwidth.
10 +- **Fast:** try zipping 100GB – download starts immediately.
11 +- **Smart:** HFS detects problems and suggest solutions.
12 - Present things the way you want: share **even a single file**, even with a different name, with our *virtual file system*.
13 - **Monitor** all activities in real-time.
14 - **Bandwidth throttling**: decide how much to give.
15 - **Direct transfers**: share large files with friends without having to upload them first.
16 -- **Expandable**: find the right plugin, or create you own
16 +- **Expandable**: install plugins for additional features.
17
18 Runs on: Windows, Linux, macOS, FreeBSD, Android
19
@@ -54,15 +54,14 @@ Runs on: Windows, Linux, macOS, FreeBSD, Android
54
55 If you need [Docker installation](https://github.com/damienzonly/hfs-docker) or [Service installation](https://github.com/rejetto/hfs/wiki/Service-installation), click the links.
56
57 -Minimum Windows version required is 10 or Server 2019. If you have a previous version, you can still follow instructions for [Other systems](#other-systems)
57 +Minimum Windows version required is 10 or Server 2019.
58
59 -1. go to https://github.com/rejetto/hfs/releases
60 -2. click on `Assets`
61 -3. **download** the right version for your system, unzip and launch `hfs` file.
62 - - Mac: if you get *"cannot be opened because it is from an unidentified developer"*,
59 +1. Download the zip file for your operating system from https://github.com/rejetto/hfs/releases
60 + - ⚠️ If you have Linux ARM or other unlisted/unsupported platforms, please see the [Other systems](#other-systems) section.
61 +2. Unzip and launch `hfs` file.
62 + - ⚠️ Mac: if you get *"cannot be opened because it is from an unidentified developer"*,
63 you can hold `control` key while clicking, then click `open`.
64 - - If your system isn't listed, please see the [Other systems](#other-systems) section.
65 -4. the browser should automatically open on `localhost` address, so you can configure the rest in the Admin-panel.
64 +3. The browser should automatically open on `localhost` address, so you can configure the rest in the Admin-panel.
65
66 Troubleshooting
67 - if a browser cannot be opened on the computer where you are installing HFS,
dev-plugins.md
+7 -7
@@ -18,7 +18,7 @@ This is probably the easiest form to start with.
18
19 A neater way is to keep it both in the form of github repo and installed plugin.
20 If you want to do so, have a folder with your github repo in it, *outside* your `.hfs` folder.
21 -As you'll see in the [[Publish your plugin]] section, you should keep your files inside the `dist` subfolder.
21 +As you'll see in the [Publish your plugin](#publish-your-plugin) section, you should keep your files inside the `dist` subfolder.
22 Then you'll need to link it inside the `plugins` folder.
23 If you go in your `.hfs/plugins` folder on linux and mac, and enter
24
@@ -511,7 +511,7 @@ E.g. HFS.onEvent("entryIcon:after", ...)
511 This is a list of available frontend-events, with respective object parameter and output.
512
513 - `additionalEntryDetails`
514 - - you receive each entry of the list, and optionally produce HTML code that will be added in the `entry-details` container.
514 + - use this to add HTML at the beginning of the `entry-details` container.
515 - parameter `{ entry: DirEntry }` current entry. The `DirEntry` type is an object with the following properties:
516 - `name: string` name of the entry.
517 - `ext: string` just the extension part of the name, dot excluded and lowercase.
@@ -528,20 +528,20 @@ This is a list of available frontend-events, with respective object parameter an
528 - `getDefaultIcon: ()=>ReactElement` produces the default icon for this entry
529 - output `Html`
530 - `entry`
531 - - you receive each entry of the list, and optionally produce HTML code that will completely replace the entry row/slot.
531 + - called displaying each entry of the list, and optionally produce HTML code that will completely replace the entry row/slot.
532 - parameter `{ entry: DirEntry }` (refer above for DirEntry object)
533 - output `Html`
534 - return null if you want to hide this entry, or undefined to leave it unchanged
535 - `afterEntryName`
536 - - you receive each entry of the list, and optionally produce HTML code that will be added after the name of the entry.
536 + - use this to add HTML after the name of the entry.
537 - parameter `{ entry: DirEntry }` (refer above for DirEntry object)
538 - output `Html`
539 - `entryIcon`
540 - - you receive an entry of the list and optionally produce HTML that will be used in place of the standard icon.
540 + - use this to change the entry icon.
541 - parameter `{ entry: DirEntry }` (refer above for DirEntry object)
542 - output `Html`
543 - `beforeHeader` & `afterHeader`
544 - - use this to produce content that should go right before/after the `header` part
544 + - use this to add HTML right before/after the `header` part
545 - output `Html`
546 - `beforeLogin`
547 - no parameter
@@ -876,7 +876,7 @@ While you may just put a zip on any website, that would require manual installat
876 If you want to appear in the Admin-panel, for easier finding and installation, please do as follows.
877
878 Be sure that you are exporting (not returning) the essential properties, like `apiRequired`.
879 -Find the full list in the [[Things a plugin can export]], marked with "JSON syntax".
879 +Find the full list in the [Things a plugin can export](#things-a-plugin-can-export) section, marked with "JSON syntax".
880
881 Suggested method for publishing is to have a dedicated repository on GitHub, with topic `hfs-plugin`.
882 To set the topic go on the repo home and click on the gear icon near the "About" box.