mdaffin / notes Goto Github PK

There should be a way to see what notes there are in a repo. This should be the main purpose of the sidebar. Notes will be stored as files in a directory and so a tree-like structure is desired.

The primary function of the application, the ability to view written notes.

/notes/<repo>/<path to note>

Notes are stored as markdown files in a git repo stored in a gitlab project. This page needs to be able to load the markdown file from the provider and render it to HTML and display it.

• https://docs.gitlab.com/ee/api/repository_files.html

You should be able to preview a note that is being edited so that you can see what it will look like before the note is saved. This preview should be optional and the focus of the editor view should be editing.

Currently no errors are properly handled. We need a way to display errors to the end user as well as to add error handling code for every endpoint that is called.

The initial focus has been on getting the site to work with a single repo. But you should be able to load different notebooks from different repos. Each can be stored separately in localstorage and present in the UI with an easy way to switch between them.

Notes should be editable so that they can be added to or changed. They will be written in markdown so a basic markdown editor will be required. The edit view should have minimal controls to not distract from the aspects of writing the note.

The whole site needs some basic styling. We could use a component library or design things our self but we need something to give the site a consistent look and feel.

There should be a way to add and remove notes from a repo. New notes can be created in new subdirectories and directories should be created automatically. Directories can also be notes if they contain a index.md.

The sidebar should be collapsible to provide more space for editing on smaller screens or for more distraction-free editing.

Once a user has signed in they will need to pick a repo to load/access. Their selection should be stored in local storage so that we don't need to ask them again when they next visit the page - or just reload the window.

Path: /repos/

Redirect to this page if they are logged in but have not already picked a repo.

This initial implementation only need to load a single repo, future implementations will allow for multiple repos to be selected.

Currently, the note names in the sidebar have a .md extension. This is unnecessary and it would look better if only the raw name was shown.

I spend more time on the cli editing notes then on the web so a CLI to add/edit notes would be very useful.