Skip to content

Commit 7698de8

Browse files
committed
Added some notes.
1 parent 42c5b4a commit 7698de8

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
PHP based viewer for Markdown files, to view them with fenced code highlighting and navigation.
44

55
It is designed to be used for viewing markdown-based documentation files, in a fire and forget
6-
way. The layout is based on Bootstrap 4, and does not need any additional configuration.
6+
way. The layout is based on [Bootstrap 5](https://getbootstrap.com), and does not need any
7+
additional configuration.
78

89
## Requirements
910

10-
- PHP7.3+
11+
- PHP7.4+
1112

1213
## Features
1314

@@ -69,7 +70,7 @@ use Mistralys\MarkdownViewer\DocsManager;
6970

7071
$manager = new DocsManager();
7172

72-
// Add a single folder, non recursive.
73+
// Add a single folder, non-recursive.
7374
$manager->addFile('Name of the file', '/path/to/file.md');
7475
```
7576

@@ -82,7 +83,7 @@ use Mistralys\MarkdownViewer\DocsManager;
8283

8384
$manager = new DocsManager();
8485

85-
// Add a single folder, non recursive.
86+
// Add a single folder, non-recursive.
8687
$manager->addFolder('/path/to/files');
8788

8889
// Add a folder and all its subfolders
@@ -97,7 +98,7 @@ use Mistralys\MarkdownViewer\DocsManager;
9798

9899
$manager = new DocsManager();
99100

100-
// Add all TXT files from a single folder, non recursive.
101+
// Add all TXT files from a single folder, non-recursive.
101102
$manager->addFolder('/path/to/files', false, 'txt');
102103
```
103104

@@ -177,3 +178,7 @@ The command looks like this:
177178
```
178179

179180
File paths are relative to the source markdown file.
181+
182+
> NOTE: It is easy to go overboard with includes. Keep in mind that Markdown files
183+
> are meant to be read as-is. Splitting them up too much will make them unreadable
184+
> without the UI. Use them where it makes sense, like large code samples.

0 commit comments

Comments
 (0)