From 0b0e23d0daa7cea6d9d293c3c64452c36aae740a Mon Sep 17 00:00:00 2001 From: Knah Tsaeb Date: Wed, 14 Oct 2020 12:28:56 +0200 Subject: [PATCH] Update README --- README.md | 9 ++++++++- content/default.md | 9 ++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6c73be7..4318526 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,13 @@ MyNovi | My Notes Viewer is simple markdown viewer made for my usage. - No configuration - Easy install - Auto ToC (Table of Content) +- Browser lazy loading in image - KISS +### Limitations + +MyNovi only work with one level dir (for moment). + --- ## Setup @@ -15,7 +20,7 @@ Clone this Mynovi using 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` @@ -28,6 +33,8 @@ Put your markdown file in 'content' dir via FTP OR SSH. That's all. +You can personalize the default page by creating file **content/index.md**. + ### Advanced usage Use synchronisation tools like NextCloud. Sync 'content' dir with your desktop. diff --git a/content/default.md b/content/default.md index 6c73be7..4318526 100644 --- a/content/default.md +++ b/content/default.md @@ -6,8 +6,13 @@ MyNovi | My Notes Viewer is simple markdown viewer made for my usage. - No configuration - Easy install - Auto ToC (Table of Content) +- Browser lazy loading in image - KISS +### Limitations + +MyNovi only work with one level dir (for moment). + --- ## Setup @@ -15,7 +20,7 @@ Clone this Mynovi using 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` @@ -28,6 +33,8 @@ Put your markdown file in 'content' dir via FTP OR SSH. That's all. +You can personalize the default page by creating file **content/index.md**. + ### Advanced usage Use synchronisation tools like NextCloud. Sync 'content' dir with your desktop.