https://github.com/funnoober/noobdocsgodot
A plain simple markdown editor and manager written in Godot
https://github.com/funnoober/noobdocsgodot
godot godot-engine godot4 markdown-editor markdown-viewer note-taking notepad notes-app sync
Last synced: 5 months ago
JSON representation
A plain simple markdown editor and manager written in Godot
- Host: GitHub
- URL: https://github.com/funnoober/noobdocsgodot
- Owner: FunNoober
- License: mit
- Created: 2024-07-17T02:26:50.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-04T21:14:57.000Z (almost 2 years ago)
- Last Synced: 2025-04-13T08:08:27.912Z (about 1 year ago)
- Topics: godot, godot-engine, godot4, markdown-editor, markdown-viewer, note-taking, notepad, notes-app, sync
- Language: GDScript
- Homepage:
- Size: 1.26 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NoobDocs
## Goals
1. **Lightweight** \
NoobDocs is designed and intended to be snappy on most hardware.
2. **Nice UI** \
The UI should not get in the way of using the program.
3. **Always Accessible Data** \
Data should not be stored in any propriety formats and users should have access to their data at all times.
## Building
NoobDocs is written in the Godot Engine, so any platform that Godot supports, NoobDocs can target. \
**Requirements:**
- [Godot 4.2](https://godotengine.org/download/archive/4.2.2-stable/) or [up](https://godotengine.org/)
- RCedit (if compiling to Windows platforms)
**To build:**
1. Clone or download this repository
2. Extract the files (if you downloaded)
3. Open the Godot project (Godot version 4.2+)
4. In the top right, click "Project"
5. In the drop down menu, select "Export..."
6. To add a build target, you can use the "Add..." button, or to export to Windows Desktop, you can use the build target that is already there.
7. Select the output directory
## Credits:
- MarkdownLabel by daenvil
- Roboto (font)
- Courier Prime (font)
- Material Icons
## NoobDocs Example Sync Server
The NoobDocs example sync server an example implementation of how to write a sync server for NoobDocs. This sync server is usable, however it was more written with the intent of being something that other people can base their own implementations off of.
### Building
**Requirements:**
- [Golang](https://go.dev/)
**To build:**
1. Clone or download this repository
2. Extract the files (if you downloaded)
3. CD into the directory titled "sync_server"
4. Run `go build .`
**IMPORTANT NOTE:** \
The sync server expects to find a file titled `config.json`. If the sync server can not find this file, then it will not launch.
- **[Writing your own sync server](CustomSyncServer.md)**
- **[Running the sync server in docker](sync_server/running-in-docker.md)**