Front End Documentation - Shanfang/SmartNote GitHub Wiki

Table of Contents

  1. Login
  2. Generate URL Note
  3. Add/Delete Markdown Note
  4. Add Tag
  5. Archive Note(Classify), View Note & Modify Note
  6. Search Note
  7. About
  8. Signout

Login

We provide a default account with username software and password cen5035.

  1. Input software and cen5035 to textboxs for log in.
  2. Press Login button.

Unauthorized accounts or empty username/password are not allowed to access the note resource with hint Incorrect account or password.

Generate URL Note

  1. Select the URL Note section from the left column and start taking notes from URLs.
  2. Copy and paste or type the target URL in the input box.
  3. Press Enter.
  4. Take a breath and wait for the magic. A note will be generated automatically from the target URL, it might be a bit slow as we are pulling data from the source URL.

For this type of note, you can save it but can't edit the content since the content is directly fetched from other resources. But you can give it a costumed note title and tag. That's the way it works now, we might make it more powerful by enabling editing the note in the future.

Add/Delete Markdown Note

One of the cool features is that making a markdown note is as easy as taking regular markdown notes.

  1. Select the Add Note section in the left column.
  2. Input note title and select tag with whatever you like.
  3. Start taking note in markdown style and select the format from the tool bar.
  4. Click the Save button on the upright corner. You note would be saved and stored in the archived notes. You can search for it, edit it, delete it later on.

Just like deleting files from our computer, you are asked for a confirmation. Give it a try and play with it!

Add Tag

  1. Select the Tag section from the left column and start adding tag
  2. Input tag information with text or emoji.
  3. Press Enter to add tag to the tag list.

The basic functionality of tags is to categorize notes. This makes you a more organized person! Tags can be numbers, words, and emojis. Of course, you can add new tags, delete tags.

Archive Note(Classify), View Note & Modify Note

Clicking the 'Archive' section on the left column, you will see all your archived notes. Double click on the note to open it. As mentioned above, URL note cannot be modified. So you can make changes to other types of notes.

  1. Check Archived Notes by clicking the Archive section from the left column.
  2. The initial archive section would show all notes.
  3. Select tag on the upper tag column to see interested notes classified by tag.
  4. View Note by double-clicking the white space around Note Title.
  5. In View Note page, click Modify button to modify note and then press Save.
  6. In View Note page, click Delete button to delete note and then confirm your operation.

As expected, you can search note either by its title or tag. After you input the search entry and hit enter, all matching notes show up.

  1. Select the Search section from the left column and start searching.
  2. Input keyword of note title or tag in the input box.
  3. Press Enter to see search results.

About

Want to know more about this application or our team? Check information on About page.

  1. Click the About section in the left column.

Sign Out

Bingo! That's all for your note taking tour. Now it is time for logging out.

  1. Click the stack icon lies at the bottom of the left column.
  2. Then press the Sign Out.

After that, you will be navigated to the login page.

⚠️ **GitHub.com Fallback** ⚠️