# Quick user guide

## First time with Marknotes ?

If you like marknotes, please hit the button at %GITHUB%. This will encourage me to continue developing the software even further.

Table of contents

### You don't see the list of files/folders

On small screen like smartphones, the left pane (aka the `treeview`) isn't displayed by default. To see it, just click on the icon that you can see in the header of the page. This icon will toggle the visibility of the `treeview`.

### You wish to add a note

First time with marknotes and nothing to display ? In order to create a new note, you can do it directly on disk or by using the interface.

#### Directly on disk (on localhost)

Probably the most easy way when you're working on a localhost environment : just go to the folder `%DOCS%` and create any folder and files. The file's extension should be `.md` (and not .markdown f.i.). Go back here and refresh the screen. If everything is fine, you'll see your added files / folders in the `treeview`. If you don't see them, clear the cache by clicking on the icon (see in the top right of the screen).

#### By using the interface (online)

In the right side of the header, you'll see this icon : . Click on it and when prompted, fill in the login and the password to make the connexion. By default, the login is admin and the password is marknotes. You can of course change them later on by editing the `settings.json.dist` file. Once connected, a visual tip that you're well connected is the new look of the icon : no more (going inside) but well (leaving). In the `treeview` right-clic on an existing folder (by default called `docs`). You'll get a popup menu with at least two new items : `Create a new folder` and `Create a new note`. Click on `Create a new note` to go into the editor window, type your note and save it and quit the editor. The note will be then displayed and saved on disk (in the `%DOCS%` folder).

### More tutorials

Please visit the marknotes site at https://www.marknotes.fr. Click on the `marknotes` folder from the `treeview`. You'll get the latest version of the documentation, how to customize marknotes to fit to your needs, how to use the dozens of plugins, ...

### Any questions

marknotes is an Open Source application hosted on GitHub. If you've a question or if you think you've discovered a bug, please leave a message to %GITHUB%/issues and I'll try to answer you as fast as possible.

If you like marknotes, please hit the button at %GITHUB%. This will encourage me to continue developing the software even further.