Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New and Improved Documentation #1

Open
wants to merge 29 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# massCode documentaion
# massCode documentaion

This is the repository in which the massCode documentation is hosted.

# Contribution

If you spot any spelling errors, incorrect instructions or generally unclear things, please feel free to fork this repository and open a pull request after you've made the necessary changes.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Welcome

This is the official documentation for massCode a free and open source code snippets manager for developers.
This is the official documentation for massCode, the free and open source snippet manager designed for developers.

[Get started](/essentials/layout.md)
[Get Started →](/essentials/layout.md)
13 changes: 6 additions & 7 deletions docs/essentials/assistant.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Tray Assistant

> This feature available only on macOS.
::: NOTE
The tray assistant is only available on MacOS.
:::

massCode assistant lives in the tray and gives you the ability to always have quick access to your snippets using the search. The snippet you selected will be copied to the clipboard.
The tray assistant lives in your tray (obviously) and gives you the ability to access your snippets in a jiffy. The snippet you select will be copied to the clipboard.

## Show Assistant
## Using the Assistant

Follow one of the following steps:

- Click on the tray icon
- Press <kbd>Option+S</kbd>
To use the assistant, click on the tray icon or press <kbd>Option+S</kbd>.
22 changes: 12 additions & 10 deletions docs/essentials/folders.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
# Folders

massCode allows you to organize your snippets into multi-level folders. When you select a sidebar folder, all snippets in that folder, as well as in all subfolders, will be displayed in the second column.
massCode allows you to organize your snippets into multi-level folders. When you select a folder in the sidebar, all of the snippets in that folder, as well as in its subfolders, will be displayed in the second column.

## Adding a folder
## Creating a folder

Follow one of the following steps:
To create a folder, there are three methods, which are listed below:

- Select **"File"** > **"New Folder"** from the menu bar.
- Click **"+"** button opposite **"FOLDERS"** in the library to add a new folder.
- Press <kbd>Shift+Cmd+N</kbd> on macOS or <kbd>Shift+Ctrl+N</kbd> on Windows or Linux.
- Click **"+"** button opposite **"FOLDERS"** in the library to create a new folder.
- Press <kbd>Shift+Cmd+N</kbd> on macOS or <kbd>Shift+Ctrl+N</kbd> on Windows and Linux.

## Moving to folder
## Moving Folders

Drag and drop the required folder to another folder.
Drag and drop the required folder into another folder.

## Renaming and Deleting

Call the context menu by right-clicking on the folder and selecting **"Rename"** or **"Delete"**.
Bring up the context menu by right-clicking on the folder and selecting **"Rename"** or **"Delete"**.

> Deleting the folder will cause all snippets in it, as well as in all sub-folders, to move to **"InBox"**.
::: WARNING
Deleting the folder will cause all snippets in it, as well as in all sub-folders, to move to **"Trash"**.
:::

## Set the Default Folder Language

Call the context menu by right-clicking on the folder and select **"Default Language"**.
Bring up the context menu by right-clicking on the folder and select **"Default Language"**.
19 changes: 8 additions & 11 deletions docs/essentials/fragments.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
# Fragments

Fragments can also be attributed to the way snippets are organized. You can create tabs inside a snippet, for example, to create different versions of snippets or when a snippet consists of different languages.
Fragments are just multiple snippets stored as one. They are stored as tabs within the snippet, and can be completely different langauges or perform completely different tasks. For example, you can have two snippets in two different languages that perform similar functions, stored in one (you can use it for anything else too).

## Adding Fragment
## Creating a Fragment

Follow one of the following steps:
To create a fragment, either click the **"+"** button in the top right corner of the editor pane, or press <kbd>Cmd+T</kbd> on macOS or <kbd>Ctrl+F</kbd> on Windows and Linux.

- Click **"+"** button on the top right corner of the editor.
- Press <kbd>Cmd+T</kbd> on macOS or <kbd>Ctrl+F</kbd> on Windows or Linux.
## Renaming and Deleting Fragments

## Renaming and Deleting
Bring up the context menu by right-clicking on the fragment and selecting **Rename** or **Delete**.

Call the context menu by right-clicking on the fragment and selecting **"Rename"** or **"Delete"**.

::: warning
The deleted fragment cannot be recovered.
:::
::: WARNING
A deleted fragment cannot be recovered by any means. Proceed with caution!
:::
16 changes: 14 additions & 2 deletions docs/essentials/layout.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Layout

massCode has a three-column interface. The first column displays the application library where all snippets are stored. The second column displays all the snippets in the selected location. And the third column is the code editor, where you can edit the snippet code.
massCode has an easy to use, three-column interface. This design maximises efficiency and the amount of relevant content you can view at once.

<img :src="$withBase('/assets/img/preview-app.png')">
<img :src="$withBase('/assets/img/preview-app.png')">

## First Column

The first column displays the application library. The application library houses all of the directories for your snippets and subfolders.

## Second Column

The second column displays all of the snippets in the selected location.

## Third Column

The last (but not least) column is the editor pane. This is most crucial part of the app and is where you will edit your snippets in, add tags and create fragments.
14 changes: 7 additions & 7 deletions docs/essentials/library.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Library

The library located in the first column consists of system folders **"InBox"**, **"Favorites"**, **"All Snippets"**, **"Trash"**.
The library is located in the first column, and contains the **InBox**, **Favorites**, **All Snippets** and **Trash** folders.

## Inbox

This folder contains all unorganized snippets.
This folder contains all unorganized snippets (any snippets that have not been placed in a folder).

## Favorites

You can add your favorite snippets to this folder for quick access.
This folder contains all of the snippets that you have favourited, allowing for quick access.

## All Snippets

This folder contains all your snippets.
This folder contains all of your snippets, regardless of location.

## Trash

This is where the snippets you delete get in. You can completely delete snippets in this folder by calling the context menu on **"Trash"** and selecting **"Empty Trash"**.
This is where any snippets you delete will go. You can empty the contents of it by bringing up with context menu by right clicking **"Trash"** and selecting **"Empty Trash"**.

::: warning
Cleaning the trash will result in the complete removal of snippets. This action cannot be undone.
:::
Emptying the trash cannot be undone. Proceed with caution!
:::
4 changes: 2 additions & 2 deletions docs/essentials/search.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Search

Follow one of the following steps:
To use the search feature in massCode, there are three methods which are listed below:

- Select **"Edit"** > **"Find"** from the menu bar.
- Click on the search entry field at the top of the second column.
- Press <kbd>Cmd+F</kbd> on macOS or <kbd>Ctrl+F</kbd> on Windows or Linux.
- Press <kbd>Cmd+F</kbd> on macOS or <kbd>Ctrl+F</kbd> on Windows and Linux.
31 changes: 11 additions & 20 deletions docs/essentials/snippets.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,30 +16,21 @@ Follow one of the following steps:

In the bottom right corner of the editor press the current snippet language, by default it is **"Plain text"**, then select the language you need from the drop-down list.

## Moving Snippet
## Moving a Snippet

Drag and drop the snippet to the desired folder.
Drag and drop the snippet into the desired folder.

## Deleting Snippet
## Deleting a Snippet

Call the context menu by right-clicking on the snippet and selecting **"Delete "**.
Bring up the context menu by right-clicking on the snippet and selecting **"Delete"**. The snippet will be moved to "**Trash"**. If needed, you can restore the snippet by dragging it back into a folder.

> The snippet will be moved to "**Trash "**. Later you can return the snippet back by dragging it back to the desired folder.
## Copying a Snippet

## Copying Snippet
To copy a snippet, either click the <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-clipboard"><path d="M16 4h2a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6a2 2 0 0 1 2-2h2"></path><rect x="8" y="2" width="8" height="4" rx="1" ry="1"></rect></svg> button in the top right corner of the editor or press <kbd>Shift+Cmd+C</kbd> on macOS or <kbd>Shift+Ctrl+C</kbd> on Windows and Linux.

Follow one of the following steps:

- Click <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-clipboard"><path d="M16 4h2a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6a2 2 0 0 1 2-2h2"></path><rect x="8" y="2" width="8" height="4" rx="1" ry="1"></rect></svg> button on the top right corner of the editor.
- Press <kbd>Shift+Cmd+C</kbd> on macOS or <kbd>Shift+Ctrl+C</kbd> on Windows or Linux.

## Formatting Snippet

Snippet formatting makes the snippet code formatted.

Follow one of the following steps:

- Select **"Editor"** > **"Format"** from the menu bar.
- Press <kbd>Shift+Cmd+F</kbd> on macOS or <kbd>Shift+Ctrl+F</kbd> on Windows or Linux.
## Formatting a Snippet

> Not all languages can be formatted at this time.
Formatting a snippet in massCode is simple and easy to grasp. To format one, either select **"Editor"** > **"Format"** from the menu bar or press <kbd>Shift+Cmd+F</kbd> on macOS or <kbd>Shift+Ctrl+F</kbd> on Windows and Linux.
::: NOTE
Not all languages can be formatted at the moment. This will change in the future.
:::
4 changes: 2 additions & 2 deletions docs/essentials/sync.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Sync
# Synchronization

massCode gives you the ability to move your snipe library to the right place on your computer. And so you can select folders of synchronization services such as iCloud Drive, Google Drive or Dropbox or other similar services and get the ability to synchronize your library on other computers.
massCode offers the ability to move your snippet library to anywhere on your computer. Thus, you should be able to synchronize your library to other computers using a service such as Google Drive, iCloud, etc.
20 changes: 11 additions & 9 deletions docs/essentials/tags.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
# Tags

Tags are another way to organize your snippets. Unlike folders, snippets can have many tags.
Tags are another way to organize your snippets and keep productive.

## Search for tagged snippets
## Searching for Tagged Snippets

Click on **"TAGS "** beside **"LIBRARY "** in the sidebar to go into tag view mode. Click on the tag that you want.
Click on **"TAGS"** besides **"LIBRARY"** in the sidebar to go into tag view mode. Within that, select any tag you want to view snippets in.

## Adding a tag
## Adding a Tag

Select the snippet in which you want to add a tag, then enter a tag name in the **"Add Tag "** field below the snippet name.
Select the snippet to which you want to add a tag, then enter a tag name in the **"Add Tag"** field below the snippet name.

> If a tag already exists, it will be displayed in the pop-up menu, you can select from it. Tags are unique and cannot be repeated.
> If a tag already exists, it will be displayed in a pop-up menu from which you can select the tag. Tags are unique and cannot have duplicates.

## Deleting Tag
## Deleting a Tag

Call the context menu by right-clicking on the tag and select **"Delete "**.
Bring up the context menu by right-clicking on the tag and selecting **"Delete"**.

> Delete the tag, delete it as well as all the snippets that used it.
::: NOTE
Deleting a tag does not delete any snippets in it.
:::
8 changes: 3 additions & 5 deletions docs/markdown/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Markdown

To use the Markdown you need to set the snippet language in **"Markdown"**. To do this, click on the language selector located at the bottom left of the editor panel, and choose **"Markdown"** from the drop-down list.
To utilise Markdown in massCode, you will need to first set the snippet language to **"Markdown"**. In order to do this, click on the language selector in the bottom left of the editor panel, and choose **"Markdown"** from the list.

## Preview Markdown
## Previewing Markdown

Follow one of the following steps:
- Select **"Editor"** > **"Preview Markdown"** from the menu bar.
- Click <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-eye"><path d="M1 12s4-8 11-8 11 8 11 8-4 8-11 8-11-8-11-8z"></path><circle cx="12" cy="12" r="3"></circle></svg> button on the top right corner of the editor
To preview your Markdown snippets, either select **"Editor"** > **"Preview Markdown"** from the menu bar, or click the <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-eye"><path d="M1 12s4-8 11-8 11 8 11 8-4 8-11 8-11-8-11-8z"></path><circle cx="12" cy="12" r="3"></circle></svg> button, which is located in the top right corner of the editor.