Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngn13/note-server
A web server to host your markdown notes
https://github.com/ngn13/note-server
markdown-note-reader markdown-notes note-hosting note-markdown note-search note-sharing note-taking
Last synced: about 2 months ago
JSON representation
A web server to host your markdown notes
- Host: GitHub
- URL: https://github.com/ngn13/note-server
- Owner: ngn13
- License: gpl-3.0
- Created: 2023-07-06T00:11:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-08T00:45:06.000Z (4 months ago)
- Last Synced: 2024-09-08T01:42:02.888Z (4 months ago)
- Topics: markdown-note-reader, markdown-notes, note-hosting, note-markdown, note-search, note-sharing, note-taking
- Language: CSS
- Homepage:
- Size: 1.32 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Note Server 📝 Host your markdown notes
Just a web server that you can use to host
your markdown notes - written in Go!
## ✨ Features
- Minimal dark UI (with no javascript)
- Content and path based searching
- Modification time based sorting
- Image and link support
## 😋 Setup
### with Docker
```bash
# bring in your notes, for example:
git clone https://github.com/your/cool-notes.git
mv cool-notes notes
docker run -d -v $PWD/notes:/notes \
-p 80:8080 \
--name my-notes \
ghcr.io/ngn13/note-server
```
Now you can connect to note server on port 80, you can extend this setup with a reverse proxy if you wish.
### without Docker
You can build and install the application from the source using `make`:
```bash
# obtain the latest sources
git clone https://github.com/ngn13/note-server
cd note-server
make
```
To install the binary to your PATH, you can use run the installation command as root:
```bash
sudo make install
```
Then you can run the server with `note-server` command:
```bash
note-server -notes /path/to/your/notes
```
## ⚙️ Options
To list available command-line options, use the `-help` flag:
```
Usage of note-server:
-interface string
Web server interface (host:port) (default "127.0.0.1:8080")
-notes string
Path for the directory that contains your notes
-static string
Static files directory path (default "/usr/lib/note-server/static")
-views string
HTML templates directory path (default "/usr/lib/note-server/views")
```
## 🔄 Auto-updating your notes
If you are using git for your notes, then you can setup a cronjob to auto-update your notes.
To do this add this enrty to your `/etc/crontab`:
```
0 * * * * your-username cd /path/to/your/notes && /usr/bin/git pull
```
This entry will pull and sync your notes with the remote every hour.
## 🔗 Credit
- [github-markdown-css](https://github.com/sindresorhus/github-markdown-css): Used for markdown rendering
- [nerdfonts](https://github.com/ryanoasis/nerd-fonts): Fonts used in the application