Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/balder1840/memodown
memorize things down with markdown.
https://github.com/balder1840/memodown
blazor knowledge-base knowledge-management markdown markdown-editor markdown-preview
Last synced: about 2 months ago
JSON representation
memorize things down with markdown.
- Host: GitHub
- URL: https://github.com/balder1840/memodown
- Owner: Balder1840
- License: mit
- Created: 2024-04-28T02:53:20.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-12T07:51:40.000Z (6 months ago)
- Last Synced: 2024-10-13T16:42:43.105Z (3 months ago)
- Topics: blazor, knowledge-base, knowledge-management, markdown, markdown-editor, markdown-preview
- Language: C#
- Homepage:
- Size: 336 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MemoDown
A simple knowledge management web application supports markdown, powered by blazor.
# Features
- [x] Full markdown support powered by [cherry-markdown](https://github.com/Tencent/cherry-markdown124)
- [x] Simple and Clean UI
- [x] Plain markdown files are supported
- [x] Images are supported, uploading or external
- [x] Saving all resources to local file system
- [x] Multiple level hierarchy sidebar
- [x] Automatically saving
- [x] Sync to Github
# Usage
## Build from source
- For Windows
```cmd
dotnet build -c Release -r win-x64 --self-contained true
```
- For Linux
```bash
dotnet build -c Release -r linux-x64 --self-contained true
```
## Configurations
```json
"MemoDown": {
"MemoDir": "/path/to/markdown", // default to C:\Users\[UserName]\memo on Windows or /home/memo on Linux
"AutoSavingIntervalSecond": 30,
"UploadsDir": "/path/to/uploads", // default to [MemoDir]/uploads
"UploadsVirtualPath": "request virtual path for uploads", // default to uploads
"CleanUploadsAt": "0 1 * * *", linux cron expression, better before AutoSyncAt
"Account": {
"UserName": "your user name",
"Password": "your password hash"
},
"CloudflareTurnstile": {
"Enable": false,
"SiteKey": "your turnstile SiteKey",
"SecretKey": "your turnstile SecretKey"
},
"Github": {
"Enable": false,
"PAT": "your Personal Access Token",
"RepoName": "your repo to sync to",
"RepoOwner": "owner name of the repo",
"Branch": "branch name", // default to main
"EnableAutoSync": false,
"AutoSyncAt": "0 2 * * *" // linux cron expression
}
}
```
> you may need the [password-hasher](https://github.com/Balder1840/password-hasher) to hash your password
## Using docker
- Create builder for cross-platform docker building (optional)
```bash
docker buildx create --driver-opt default-load=true --name=container --use
docker buildx inspect --bootstrap container
```
- Build docker image (optional)
- Push to docker hub
```bash
docker buildx build --platform=linux/amd64,linux/arm64 --push --builder=container -t balder1840/memo-down:v1.0.1 .
```
- Or load to local
```bash
docker buildx build --platform=linux/amd64 --load --builder=container -t balder1840/memo-down:v1.0.1 .
```
- Use the image
```docker
docker run -d \
--name memodown \
-p 8080:8080 \
-e MemoDown__Account__UserName=your_user_name \
-e MemoDown__Account__Password=your_password_hash \
-v ~/memo:/memo \
balder1840/memo-down:tagname \
```