https://github.com/tcm9439/structural-note

A desktop app for creating note with structural data. It is like having a small database inside a text file which you can define schema structure and edit corresponding records.
https://github.com/tcm9439/structural-note

Last synced: about 2 months ago
JSON representation

A desktop app for creating note with structural data. It is like having a small database inside a text file which you can define schema structure and edit corresponding records.

• Host: GitHub
• URL: https://github.com/tcm9439/structural-note
• Owner: tcm9439
• Created: 2023-07-29T15:03:06.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-06-15T08:55:01.000Z (8 months ago)
• Last Synced: 2024-12-01T01:05:10.318Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 7.22 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Structural Note

A desktop app for creating note with structural data. It is like having a small database inside a text file which you can define schema structure and edit corresponding records. In between the structural records, you can insert note in plain text or markdown format. 

## Demo

[Online Demo](https://tcm9439.github.io/structural-note-demo/test/template/) for note editing functions.

**Note**

- Don't go the root `index.html` or `setting/index.html` of the demo page directly, they will not work in the demo (or will work but not by it own). Use the link above as the entry point and only navigate around by the UI. 

- The file-related functions (save, load, export, etc.), window-related functions and shortcut will not work in this web-based demo.

## Features & Screenshot

### Files

The app create and store the note in a custom format `.structnote`. You can share the file to the others and let them open it with Structural Note app.

Creating a new note:

![](./readme-resources/new-window.png)

![](./readme-resources/create-new-note.png)

Open a note in the file system:

![](./readme-resources/load.png)

Saving the note:

![](./readme-resources/save-as.png)

### Editing

Adding Note Elements:

![](./readme-resources/adding-section.png)

Editing Section Definition (Record Schema)

![](./readme-resources/edit-section-def.png)

### Value Validation

You can set up rules to enable validation:

![](./readme-resources/value-validation.png)

### Export to Various Format

Exporting the note to Markdown format with preview:

![](./readme-resources/export-to-markdown.png)

### Setting

![](./readme-resources/setting.png)

Multi-language support (English & Chinese):

![](./readme-resources/multi-lang.png)