3
3
PHP based viewer for Markdown files, to view them with fenced code highlighting and navigation.
4
4
5
5
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.
7
8
8
9
## Requirements
9
10
10
- - PHP7.3 +
11
+ - PHP7.4 +
11
12
12
13
## Features
13
14
@@ -69,7 +70,7 @@ use Mistralys\MarkdownViewer\DocsManager;
69
70
70
71
$manager = new DocsManager();
71
72
72
- // Add a single folder, non recursive.
73
+ // Add a single folder, non- recursive.
73
74
$manager->addFile('Name of the file', '/path/to/file.md');
74
75
```
75
76
@@ -82,7 +83,7 @@ use Mistralys\MarkdownViewer\DocsManager;
82
83
83
84
$manager = new DocsManager();
84
85
85
- // Add a single folder, non recursive.
86
+ // Add a single folder, non- recursive.
86
87
$manager->addFolder('/path/to/files');
87
88
88
89
// Add a folder and all its subfolders
@@ -97,7 +98,7 @@ use Mistralys\MarkdownViewer\DocsManager;
97
98
98
99
$manager = new DocsManager();
99
100
100
- // Add all TXT files from a single folder, non recursive.
101
+ // Add all TXT files from a single folder, non- recursive.
101
102
$manager->addFolder('/path/to/files', false, 'txt');
102
103
```
103
104
@@ -177,3 +178,7 @@ The command looks like this:
177
178
```
178
179
179
180
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