Skip to content

Commit

Permalink
Merge branch 'feature/update-docs' of https://github.com/coenm/RepoM
Browse files Browse the repository at this point in the history
…into feature/update-docs
  • Loading branch information
coenm committed Sep 8, 2024
2 parents 34aaaf7 + c574731 commit 61de2f5
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,41 +40,41 @@ The main functionality of RepoM are the quick actions to execute per repository.

To read more about the context menu, click here.

These actions are defined in the `RepositoryActions.yaml` located in your `%APPDATA%\RepoM\` folder. More information can be found [here](docs/RepositoryActions.md).
These actions are defined in the `RepositoryActions.yaml` located in your `%APPDATA%\RepoM\` folder. More information can be found [here](docs_old/RepositoryActions.md).

## Tagging

It is possible to dynamically assign tags to repositories such that you can filter, order, and search repositories using these tags.
How to define and use tags is described in the [Tags](docs_new/Tags.md) documentation.
How to define and use tags is described in the [Tags](docs/Tags.md) documentation.

## Search

It is possible to filter or search for repositories using the search box at the top of RepoM.
See the [Search](docs_new/search.md) for more information.
See the [Search](docs/search.md) for more information.

## Ordering and Filtering

The order of the repositories shown in RepoM is customizable. The default is alphabetical on the repository name. Read more about ordering [here](docs/Ordering.md).
The order of the repositories shown in RepoM is customizable. The default is alphabetical on the repository name. Read more about ordering [here](docs_old/Ordering.md).

The repositories shown in RepoM are filtered using the search box in RepoM. But the default set can also be configured using different presets. [This page](docs/Filtering.md) describes how to create custom filter presets.
The repositories shown in RepoM are filtered using the search box in RepoM. But the default set can also be configured using different presets. [This page](docs_old/Filtering.md) describes how to create custom filter presets.

## Global configuration

When RepoM starts for the first time, a configuration file wil be created. Most of the properties can be adjusted using the UI but, at this moment, one property must be altered manually. Read more over [here](docs/Settings.md).
When RepoM starts for the first time, a configuration file wil be created. Most of the properties can be adjusted using the UI but, at this moment, one property must be altered manually. Read more over [here](docs_old/Settings.md).

## Plugins

RepoM uses plugins to extend functionality. At this moment, when a plugin is available in the installed directory, it will be found and can be enabled or disabled. This is done in the hamburger menu of RepoM. Enabling or disabling requires a restart of RepoM.

- [Plugins](docs/Plugins.md)
- [AzureDevOps](docs/RepoM.Plugin.AzureDevOps.md)
- [Clipboard](docs/RepoM.Plugin.Clipboard.md)
- [Heidi](docs/RepoM.Plugin.Heidi.md)
- [LuceneQueryParser](docs/RepoM.Plugin.LuceneQueryParser.md)
- [SonarCloud](docs/RepoM.Plugin.SonarCloud.md)
- [Statistics](docs/RepoM.Plugin.Statistics.md)
- [WebBrowser](docs/RepoM.Plugin.WebBrowser.md)
- [WindowsExplorerGitInfo](docs/RepoM.Plugin.WindowsExplorerGitInfo.md)
- [Plugins](docs_old/Plugins.md)
- [AzureDevOps](docs_old/RepoM.Plugin.AzureDevOps.md)
- [Clipboard](docs_old/RepoM.Plugin.Clipboard.md)
- [Heidi](docs_old/RepoM.Plugin.Heidi.md)
- [LuceneQueryParser](docs_old/RepoM.Plugin.LuceneQueryParser.md)
- [SonarCloud](docs_old/RepoM.Plugin.SonarCloud.md)
- [Statistics](docs_old/RepoM.Plugin.Statistics.md)
- [WebBrowser](docs_old/RepoM.Plugin.WebBrowser.md)
- [WindowsExplorerGitInfo](docs_old/RepoM.Plugin.WindowsExplorerGitInfo.md)

## Credits

Expand Down
2 changes: 1 addition & 1 deletion docs_old/RepoM.Plugin.LuceneQueryParser.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Lucene Query Parser

To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs_old/mdsource/_plugin_enable.include.md -->

## Configuration<!-- include: DocsModuleSettingsTests.DocsModuleSettings_LuceneQueryParserPackage#desc.verified.md -->

Expand Down
2 changes: 1 addition & 1 deletion docs_old/RepoM.Plugin.Statistics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This module add functionality to keep track of actions performed on repositories. This can be used in orderings (and mabye later on in filtering) of repositories.

To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs_old/mdsource/_plugin_enable.include.md -->

## Configuration<!-- include: DocsModuleSettingsTests.DocsModuleSettings_StatisticsPackage#desc.verified.md -->

Expand Down
2 changes: 1 addition & 1 deletion docs_old/RepoM.Plugin.WindowsExplorerGitInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ As an extra goodie for Windows users, RepoM automatically detects open File Expl

Note that for Windows 11 users, the title will not be updated but in the taskbar the additional git information is still visible.

To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs_old/mdsource/_plugin_enable.include.md -->

## Configuration<!-- include: DocsModuleSettingsTests.DocsModuleSettings_WindowsExplorerGitInfoPackage#desc.verified.md -->

Expand Down

0 comments on commit 61de2f5

Please sign in to comment.