Knah-Tsaeb/MyNoVi
Knah-Tsaeb/MyNoVi
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Knah Tsaeb 2020-10-14 12:28:56 +02:00
parent d3974b59cb
commit 0b0e23d0da
2 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -6,8 +6,13 @@ MyNovi | My Notes Viewer is simple markdown viewer made for my usage.
- No configuration - No configuration
- Easy install - Easy install
- Auto ToC (Table of Content) - Auto ToC (Table of Content)
- Browser lazy loading in image
- KISS - KISS
### Limitations
MyNovi only work with one level dir (for moment).
--- ---
## Setup ## Setup
@ -15,7 +20,7 @@ Clone this Mynovi using git
`git clone https://forge.leslibres.org/Knah-Tsaeb/MyNoVi.git` `git clone https://forge.leslibres.org/Knah-Tsaeb/MyNoVi.git`
Use composer to install external lib Use composer to install external lib (Parsedown and Parsedown-toc)
`cd MyNoVi` `cd MyNoVi`
@ -28,6 +33,8 @@ Put your markdown file in 'content' dir via FTP OR SSH.
That's all. That's all.
You can personalize the default page by creating file **content/index.md**.
### Advanced usage ### Advanced usage
Use synchronisation tools like NextCloud. Sync 'content' dir with your desktop. Use synchronisation tools like NextCloud. Sync 'content' dir with your desktop.

9
content/default.md
View file

@ -6,8 +6,13 @@ MyNovi | My Notes Viewer is simple markdown viewer made for my usage.
- No configuration - No configuration
- Easy install - Easy install
- Auto ToC (Table of Content) - Auto ToC (Table of Content)
- Browser lazy loading in image
- KISS - KISS
### Limitations
MyNovi only work with one level dir (for moment).
--- ---
## Setup ## Setup
@ -15,7 +20,7 @@ Clone this Mynovi using git
`git clone https://forge.leslibres.org/Knah-Tsaeb/MyNoVi.git` `git clone https://forge.leslibres.org/Knah-Tsaeb/MyNoVi.git`
Use composer to install external lib Use composer to install external lib (Parsedown and Parsedown-toc)
`cd MyNoVi` `cd MyNoVi`
@ -28,6 +33,8 @@ Put your markdown file in 'content' dir via FTP OR SSH.
That's all. That's all.
You can personalize the default page by creating file **content/index.md**.
### Advanced usage ### Advanced usage
Use synchronisation tools like NextCloud. Sync 'content' dir with your desktop. Use synchronisation tools like NextCloud. Sync 'content' dir with your desktop.