Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ec9aa79

Browse files
uggrockuggrock
committed
adding llms.txt and removing unneeded comments
1 parent 15a79cf commit ec9aa79

21 files changed

+9808
-164
lines changed

‎docs/aboutdocs.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,6 @@ import { ProFeature } from '@site/src/components/CommonBlocks';
88

99
This documentation is work in progress, the articles are being updated on a regular base.
1010

11-
<!-- You can download version of the documentation as PDF files:
12-
13-
- Documentation for TagSpaces v3 as [PDF](/pdf/tagspaces-manual-v3.pdf)
14-
- Documentation for TagSpaces v2 as [PDF](/pdf/tagspaces-manual-v2.pdf) -->
15-
1611
## Documentation structure
1712

1813
This documentation is built using [Docusaurus](https://docusaurus.io/), for a streamlined and simple user experience. Each **page** will concern a particular topic, giving **detailed and illustrated explanations** and **instructions** about it. Every page is broken down to different level headings.
@@ -29,19 +24,6 @@ We used another great open source product called [Inkscape](https://inkscape.org
2924

3025
The color of the shapes has the following HEX encoding: `#ef2dae`
3126

32-
<!-- Much effort had gone into visually illustrating the documentation, so that you can instantly find what you are looking for, or what is being described in words. Most illustrations will feature some sort of annotation. For example if a **visible element** of the User Interface is discussed, a **neon-green rectangle around an element** will mark its location on the illustrating image.
33-
34-
![](/media/introduction-main-screen.png)
35-
36-
When there are multiple elements discussed in the same paragraph, the illustrations will be further annotated with numbers, like on the image below while the corresponding numbers will be included in the text, after each element was first mentioned. For example the following image illustrates the structure of the navigation sidebar, with **major parts** (**1**) showing as unselectable titles, expandable **page titles** (**2**) will hold major **section titles** (**3**), both of which are clickable. Clicking page titles will open the corresponding page, while clicking section titles will open the page and scroll down to the start of the selected section.
37-
38-
> **Note to contributors:** When you annotate illustrations please use a rounded edge rectangle, with the following properties:
39-
40-
- **20 px radius** for the rounded corners
41-
- **#1ccd9c color**
42-
- **3-6px line width**, depending on image size (larger images can use thicker lines)
43-
Additionally, please use a **28pt font size** for numbering with a basic **sans font**. -->
44-
4527
## Text markup
4628

4729
You will notice, that certain words are marked with **bold text**. These either mean names of elements, or significant notes/concepts about usage. _Italicized words_ usually mark menu items, or other selectable elements, although it is not a hard and fast rule.

‎docs/extensions/mhtml-viewer.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ A TagSpaces extension allowing you to open MHTML and EML files.
1212
- Finding text in the current file.
1313
- File printing.
1414

15-
<!-- ![Animation of the viewerMHTML extension](/media/extensions/mhtml-viewer-readabilty-mode.gif) -->
16-
1715
![Screenshot of the MHTML viewer extension](/media/extensions/viewer-mhtml-lead.png)
1816

1917
Dialog showing the scraping details, with the ability to open the original URL in an external browser.

‎docs/extensions/slides-viewer.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ A TagSpaces extension for opening slides in HTML format created with reveal.js.
2121
The extension extracts only the content of the reveal.js presentation from the HTML file and removes all the embedded and referenced JavaScript code. For the rendering of the slides, it relies on the embedded reveal.js library. This is done to reduce the risk of opening malicious HTML files. The drawback is that the reveal.js version may be outdated and not support the newest features of the latest release.
2222
:::
2323

24-
<!-- ![Screenshot of the slides viewer](/media/extensions/slides-viewer.jpg) -->
25-
2624
## Used Libraries
2725

2826
This extension thankfully relies on the following great libraries:

‎docs/extensions/text-editor.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -44,34 +44,3 @@ If you want to extend this extension, please follow our general [extension devel
4444
## License
4545

4646
[MIT](https://github.com/tagspaces/tagspaces-extensions/blob/main/text-editor/LICENSE.txt)
47-
48-
<!--
49-
### MarkDown Editor
50-
51-
When you open a MarkDown file for editing from the [MarkDown Viewer](/extensions/md-viewer/), it will be opened with the same **Text Editor** any plain text file would, offering inline highlighting of Markdown syntax.
52-
53-
![](/media/markdown-syntax-highlight.png)
54-
55-
The difference between MarkDown and plain text editors is the two additional functions in its **FAB Overflow Menu**: _MarkDown Preview_ (**1**) and _MarkDown Help_ (**2**).
56-
57-
![](/media/markdown-editor-overflow.png)
58-
59-
The first option will open a popup window, presenting a formatted preview of the MarkDown file, similar to what you would see in the MarkDown viewer.
60-
61-
![](/media/markdown-preview.png)
62-
63-
The second option will offer some basic help about MarkDown syntax and formatting.
64-
65-
![](/media/markdown-help.png)
66-
67-
### Linking Local Files and Images
68-
69-
The Markdown editor will also allow you to **link local files and images** from within your connected location, using a path relative to your currently active folder. **Linked local images** will be shown embedded in the current markdown preview, while **linked files** will open in the default external application defined by your operating system.
70-
71-
For example, the link `[link text](images/picture.jpg)` will show the file named `picture.jpg` (located in the `images` subfolder of the folder your file is located) in the markdown viewer, while `[link text](/files/more_files/example.pdf)` will open the file named `example.pdf` (located in the `more_files` subfolder of the `files` folder, located in the current folder) in an external PDF viewer.
72-
73-
To enter a relative path, you can usually use UNIX-style slashes (`/`) in paths, e.g., `path/to/file/filename.ext`, as `node.js`, upon which TagSpaces is built, will handle them properly even on Windows. This allows for interoperability across different operating systems. If you only use Windows, however, you can use a backslash (`\`), e.g., `path\to\file\filename.ext`, if you prefer, but such paths will not be understood on any other system.
74-
75-
:::info
76-
TagSpaces only understands relative paths. You cannot reference any level above your current folder, or the root of your connected location, but might only link files located in the currently active folder, or in subfolders within.
77-
:::-->

‎docs/installation.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,6 @@ When a new version of the application is available, you will see a notification
2222
If you prefer not to have TagSpaces check automatically for new versions, you can disable this functionality in the [settings](/ui/settings).
2323
:::
2424

25-
<!-- ## Installing TagSpaces PRO
26-
Here are the steps needed for installing the PRO version on your system.
27-
- Save the installer file to a location on your hard drive.
28-
- Locate the installer and double-click to start the install process.
29-
- The Windows installer allows you to specify a custom install location. -->
30-
3125
## Installation on Windows
3226

3327
The Windows version of TagSpaces is distributed as either an `.exe` installer or a `.zip` archive file. The `.exe` file can be directly executed to start the installation. The `.zip` archive must be unzipped into a folder on your system. In the unpacked folder, you will find a file named `tagspaces.exe`, which can be executed with a double-click.
@@ -102,15 +96,6 @@ To update the **tar.gz** version, replace the contents of your current installat
10296
The Android version is meanwhile **deprecated**, we still are still releasing new versions, but we are not actively developing the app anymore.
10397
:::
10498

105-
<!-- ### From Google Play (not updated anymore)
106-
107-
You can install the Android app from the [Google Play Store](https://play.google.com/store/apps/details?id=org.tagspaces.mobileapp).
108-
:::tip
109-
The version of TagSpaces in Google Play Store is outdated and not supported anymore, please read the next section for installing the app from our web page.
110-
::: -->
111-
112-
<!-- **Updating the Android app:** Once a newer version of the Android app is published, it will be automatically installed on your mobile device within a few days. -->
113-
11499
A version of the Android app is available as an [APK file](https://www.tagspaces.org/downloads/) in the download section of our website.
115100

116101
To install the APK file, follow these steps on your Android phone:

‎docs/perspectives/folderviz.md

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -73,38 +73,3 @@ The TreeMap View represents files and folders as tiles, where the size of each t
7373
src="/media/folderviz/folderviz-treemap.avif"
7474
showCaption
7575
/>
76-
77-
<!--
78-
## Legacy Views from v2
79-
80-
### MindMap View
81-
82-
The **MindMap View** displays all folders and subfolders within the current directory in an expandable tree-node format. There are plans to enhance this view in the future with an inverted graph of tags, allowing you to navigate your tagged files via a tag group tree rather than a folder tree. This could enable drag-and-drop functionality, where moving a file between branches would automatically re-tag it.
83-
84-
![MindMap View](/media/folderviz/folderviz-mindmap.avif)
85-
86-
### TreeMap View
87-
88-
The **TreeMap View** represents files and folders as tiles, where the size of each tile corresponds to the file size relative to others in the same folder hierarchy. This provides a visual understanding of file sizes in relation to the root and each other.
89-
90-
![TreeMap View](/media/folderviz/folderviz-treemap-view.avif)
91-
92-
### Tree View
93-
94-
The **Tree View** shows a fully expanded, non-interactive folder tree, similar to **MindMap**, but static. While useful for visualizing folder hierarchies, it may struggle with performance in large directories.
95-
96-
![Tree View](/media/folderviz/folderviz-tree-view.avif)
97-
98-
### TreeMap-Navi View
99-
100-
**TreeMap Navi** is similar to **TreeMap** but omits the folder hierarchy, using the entire user interface to represent relative file sizes. This view can be particularly useful for identifying large files or folders.
101-
102-
![TreeMap Navi View](/media/folderviz/folderviz-treemap-navi.avif)
103-
104-
### Bilevel Partition
105-
106-
The **Bilevel Partition** is the most experimental view, mainly designed as a test to explore folder and file visualization capabilities. While it can generate intriguing visual results, it is likely to be removed in a future release of TagSpaces.
107-
108-
![Bilevel Partition View](/media/folderviz/bilevel-partition.avif)
109-
110-
-->

‎docs/perspectives/grid.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@ The default view in TagSpaces presents content in a grid, making it the most com
1212

1313
![screenshot of the default perspective of the app](/media/grid/grid-lead.avif)
1414

15-
<!-- :::info
16-
The colored rectangle shows the area in TagSpaces typically occupied by **[perspectives](/browsing-files)**.
17-
::: -->
18-
1915
### File Tile
2016

2117
Each tile in the grid represents the following information:
@@ -172,8 +168,6 @@ At the bottom of the dialog, you’ll find these options:
172168

173169
The dialog also indicates if the current folder has custom settings. You can reset them using the **Reset Custom Settings** button.
174170

175-
<!-- * **Show sub folders content** - If you don't care about folder structure, or do not know where in the hierarchy you would find a necessary file, you can turn this option on, to show every file from all sub folders recursively, starting from your current directory. The list will display all files in order, without any indication of their actual locations. This option will allow you to work with multiple files across a folder hierarchy at once.-->
176-
177171
### Example Configurations
178172

179173
A common arrangement found in file browsing applications is the grid. The grid view offers a resizable grid with thumbnail previews of certain file formats, for quick and effective browsing. The files and folder are represented by user interface element called cards.

‎docs/search.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -253,11 +253,6 @@ These file formats are currently supported:
253253
- **TXT** - plain text files.
254254
- **PDF** - searchable PDF documents (already OCR-ed).
255255

256-
<!-- * Office Documents: PDF, ODT, ODP, ODS, DOCX, XLSX, PPTX (extracts the text content)
257-
* Images: JPG (extracts Exif and IPTC informations)
258-
* Audios formats: MP3 (extracts id3 tags)
259-
* Ebooks: EPUB (extracts the text content) -->
260-
261256
<CenteredImage
262257
caption="Enabling full-text indexing"
263258
src="/media/locations/enable-fulltext-search.avif"

‎docs/tagging.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,6 @@ File name tagging may run into limitations due to file path length restrictions
5252

5353
As an alternative to embedding tags in file names, TagSpaces allows storing tags in sidecar files within a hidden `.ts` folder. This can be activated in the settings for all locations or per location in the properties of every location.
5454

55-
<!-- :::info
56-
Note: By default, `.ts` folders are hidden on macOS and Linux, but not on Windows.
57-
::: -->
58-
5955
When tagging a file, TagSpaces will create a corresponding sidecar file with the same name as the source file but with a `.json` extension. For example:
6056

6157
```

‎docs/thumbnails.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,4 @@ The generated thumbnails are stored in the `.ts` folder located within each fold
3838

3939
## Thumbnails on S3 Locations
4040

41-
<!-- Thumbnails are not generated automatically on S3 locations. This limitation is due to the fact that generating thumbnails requires downloading all files from the folder, which can be impractical for folders with many files. However, there is an exception: -->
42-
4341
When you upload files to an S3 location, TagSpaces will attempt to generate thumbnails during the upload process.

0 commit comments

Comments
 (0)