diff --git a/docs/assets/screenshot.png b/docs/assets/screenshot.png index 6a6e4441..7badbfd8 100644 Binary files a/docs/assets/screenshot.png and b/docs/assets/screenshot.png differ diff --git a/docs/assets/tag_bubbles.png b/docs/assets/tag_bubbles.png new file mode 100644 index 00000000..c7e7a96c Binary files /dev/null and b/docs/assets/tag_bubbles.png differ diff --git a/docs/assets/ts-9-3_logo_text.png b/docs/assets/ts-9-3_logo_text.png new file mode 100644 index 00000000..b6286186 Binary files /dev/null and b/docs/assets/ts-9-3_logo_text.png differ diff --git a/docs/index.md b/docs/index.md index 84a75d0c..9b070ca0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,52 +1,110 @@ --- title: Home +hide: + - toc --- -# Welcome to the TagStudio Documentation! +# -![TagStudio Alpha](./assets/github_header.png) - -TagStudio is a photo & file organization application with an underlying tag-based system that focuses on giving freedom and flexibility to the user. No proprietary programs or formats, no sea of sidecar files, and no complete upheaval of your filesystem structure. - -
- -![TagStudio screenshot](./assets/screenshot.png) - -
TagStudio Alpha v9.5.0 running on macOS Sequoia.
+ +
+ ![TagStudio](./assets/ts-9-3_logo_text.png){ width=80% }

A User-Focused Photo & File Management System

-## Roadmap +
-The feature [roadmap](./updates/roadmap.md) lists all of the planned core features for TagStudio to be considered "feature complete" along with estimated release milestones. The development and testing of these features takes priority over all other requested or submitted features unless they are later added to this roadmap. This helps ensure that TagStudio eventually sees a full release and becomes more usable by more people more quickly. +
+ ![TagStudio screenshot](./assets/screenshot.png){ width=80% } +
TagStudio Alpha v9.5.0 running on macOS Sequoia.
+
-## Current Features +
-### Libraries +![TagStudio screenshot](./assets/tag_bubbles.png) -- Create [libraries](./library/index.md) centered around a system directory. Libraries contain a series of entries: the representations of your files combined with metadata fields. Each entry represents a file in your library’s directory, and is linked to its location. -- Address moved, deleted, or otherwise "unlinked" files by using the "Fix Unlinked Entries" option in the Tools menu. +**TagStudio** is a photo & file organization application with an underlying tag-based system that focuses on giving freedom and flexibility to the user. No proprietary programs or formats, no sea of sidecar files, and no complete upheaval of your filesystem structure. -### Tagging + Metadata Fields +
-- Add custom powerful [tags](./library/tag.md) to your library entries -- Add [metadata fields](./library/field.md) to your library entries, including: - - Name, Author, Artist (Single-Line Text Fields) - - Description, Notes (Multi-Line Text Fields) -- Create rich tags composed of a name, color, a list of aliases, and a list of "parent tags" - these being tags in which these tags inherit values from. -- Copy and paste tags and fields across file entries -- Automatically organize tags into groups based on parent tags marked as "categories" -- Generate tags from your existing folder structure with the "Folders to Tags" macro (NOTE: these tags do NOT sync with folders after they are created) +
+ [:material-download: Download Latest Release](https://github.com/TagStudioDev/TagStudio/releases){ .md-button .md-button--primary } +
-### Search +## :material-star: Core Features -- [Search](./library/library_search.md) for file entries based on tags, file path (`path:`), file types (`filetype:`), and even media types! (`mediatype:`) -- Use and combine Boolean operators (`AND`, `OR`, `NOT`) along with parentheses groups, quotation escaping, and underscore substitution to create detailed search queries -- Use special search conditions (`special:untagged`) to find file entries without tags or fields, respectively +
-### File Entries +- :material-file-multiple:{ .lg .middle } **[All Files](./library/entry.md) Welcome** -- Nearly all [file](./library/entry.md) types are supported in TagStudio libraries - just not all have dedicated thumbnail support. -- Preview most image file types, animated GIFs, videos, plain text documents, audio files, Blender projects, and more! -- Open files or file locations by right-clicking on thumbnails and previews and selecting the respective context menu options. You can also click on the preview panel image to open the file, and click the file path label to open its location. -- Delete files from both your library and drive by right-clicking the thumbnail(s) and selecting the "Move to Trash"/"Move to Recycle Bin" option. + *** + + TagStudio works with photos, videos, music, documents, and more! **All file types** are recognized by TagStudio, with most common ones having built-in preview support. + + [:material-arrow-right: See Full Preview Support](./library/index.md#preview-support) + +- :material-tag-text:{ .lg .middle } **Create [Tags](./library/tag.md) Your Way** + + *** + + - :material-format-font: No character restrictions + - :material-form-textbox: Add aliases/alternate names + - :material-palette: Customize colors and styles + - :material-tag-multiple: Tags can be tagged with other tags! + - :material-star-four-points: And more! + +- :material-magnify:{ .lg .middle } **Powerful [Search](./library/library_search.md)** + + *** + + - Full [Boolean operator](./library/library_search.md) support + - Filenames, paths, and extensions with [glob]() syntax + - General media types (e.g. "Photo", "Video", "Document") + - Special searches (e.g. "Untagged") + - "[Smartcase](./library/library_search.md#case-sensitivity)" case sensitivity + +- :material-text-box:{ .lg .middle } **Text and Date [Fields](./library/field.md)** + + *** + + Along with tags, add custom metadata fields such as text and dates to your files! + + This is useful for adding notes and descriptions, titling files, and keeping track of extra dates and times. + +
+ +## :material-toolbox: Built Different + +
+ +- :material-scale-balance:{ .lg .middle } **Open Source** + + *** + + TagStudio is licensed under the GPL-3.0 license with the source code and executable releases available on [GitHub](https://github.com/TagStudioDev/TagStudio). + + [:material-arrow-right: View License](https://github.com/TagStudioDev/TagStudio/blob/main/LICENSE) + + [:material-arrow-right: Roadmap to MIT Core Library License](./updates/roadmap.md#core-library-api) + +- :material-database:{ .lg .middle } **Central Save File** + + *** + + Apposed to filling your drives with [sidecar files](https://en.wikipedia.org/wiki/Sidecar_file), TagStudio uses a project-like [library](./library/index.md) system that stores your tags and metadata inside a single save file per-library. + + [:material-arrow-right: Learn About the Format](./library/index.md) + +
+ +--- + +## :material-layers-triple: More Than an Application + +TagStudio aims to create an **open** and **robust** format for file tagging that isn't burdened by the limitations of traditional tagging and file metadata systems. **TagStudio** is the first proof-of-concept implementation of this system. + +
+ +- :material-map-check:{ .lg .middle } See the [**Roadmap**](./updates/roadmap.md) for future features and updates + +
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 9d712822..bdb4dde8 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -68,6 +68,10 @@ h2, margin-right: -0.8rem; } +figcaption { + margin-top: 0 !important; +} + .md-search__form { height: 1.5rem; background-color: #00004444; @@ -81,10 +85,14 @@ h2, margin-top: -0.2rem; } -.twemoji { +h1 > .twemoji { margin-top: 0.14rem; } +h2 > .twemoji { + margin-top: 0.08rem; +} + /* Matches the palette used by mkdocs-material */ .priority-high { color: #f1185a; diff --git a/docs/stylesheets/home.css b/docs/stylesheets/home.css new file mode 100644 index 00000000..c9ba11e5 --- /dev/null +++ b/docs/stylesheets/home.css @@ -0,0 +1,14 @@ +h2 { + margin: 1rem 0 0 0 !important; +} + +.md-content .md-typeset h1 { + /* display: none; */ + font-size: 0; +} + +.grid > p { + align-content: center; + font-size: 1rem !important; + line-height: 1.25rem; +} diff --git a/docs/updates/roadmap.md b/docs/updates/roadmap.md index 3715ead6..ab3641ba 100644 --- a/docs/updates/roadmap.md +++ b/docs/updates/roadmap.md @@ -51,10 +51,11 @@ Must be finalized or deemed "feature complete" before other core features are de ### :material-database-cog: Core Library + API -A separated, UI agnostic core library that is used to interface with the TagStudio library format. Would host an API for communication from outside the program. +A separated, UI agnostic core library that would be used to interface with the TagStudio library format. Would host an API for communication from outside the program. This would be licensed under the more permissive [MIT](https://en.wikipedia.org/wiki/MIT_License) license to foster wider adoption compared to the TagStudio application source code. - [ ] Core Library :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]** - [ ] Core Library API :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]** +- [ ] MIT License :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]** ### :material-clipboard-text: Format Specification