MyNoVi/README.md

40 lines
756 B
Markdown
Raw Normal View History

2020-10-08 17:00:12 +02:00
# Welcome to MyNoVi
2020-10-08 12:37:04 +02:00
2020-10-08 17:00:12 +02:00
MyNovi | My Notes Viewer is simple markdown viewer made for my usage.
## Features
- No configuration
- Easy install
- Auto ToC (Table of Content)
- KISS
---
## Setup
Clone this Mynovi using git
`git clone https://forge.leslibres.org/Knah-Tsaeb/MyNoVi.git`
Use composer to install external lib
`cd MyNoVi`
`composer install`
---
## Usage
Put your markdown file in 'content' dir via FTP OR SSH.
That's all.
### Advanced usage
Use synchronisation tools like NextCloud. Sync 'content' dir with your desktop.
Now just edit your local file and when you save file, after synchro your file is online.
---
## License
This project is licensed under the terms of the **[AGPLv3](https://www.gnu.org/licenses/agpl-3.0.txt)** license.