You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
<h1align="center">TinyDocs</h1>
2
2
<imgsrc="https://img.shields.io/github/license/vortexdevsoftware/tiny-wiki"> <imgalt="GitHub all releases"src="https://img.shields.io/github/downloads/vortexdevsoftware/tiny-wiki/total">
<palign="center">Flat-file CMS engine with search</p>
7
-
<subalign="center">And maybe editing in the future</sub>
6
+
<palign="center">Flat-file CMS engine with search<br><sub>And possibly editing in the future</sub></p>
8
7
9
-
Create documentation webpages with Markdown, syntax highlighting with [Highlight.js](https://highlightjs.org/)
8
+
<br><br>
9
+
Create documentation webpages with Markdown, syntax highlighting
10
10
11
11
## Why use TinyDocs?
12
12
Are you looking for a simple way to document anything?
@@ -18,6 +18,8 @@ Are you looking for a simple way to document anything?
18
18
4. 🧩 **Scalable**: *TinyDocs* provides a scalable solution, allowing your documentation to grow and expand as needed to accommodate changes and additions.
19
19
5. 📝 **Documented**: Everything that you would want to change is documented in the source code.
20
20
21
+
Live example: https://docs.vortex-dev.com
22
+
21
23
## Modules
22
24
*TinyDocs* offers a module system: small PHP packages that add or change functionality, such as the table of contents, search bar, and sub-title, they are located in the `Modules/` directory
23
25
@@ -39,7 +41,7 @@ In order to configure TinyDocs you will need to upload the files to your web ser
39
41
5. Add your Markdown files to the pages/ directory, organizing them into folders if you wish to create categories.
40
42
41
43
## Dependencies
42
-
*[PHP](https://secure.php.net/) >= 5.3.0
44
+
*[PHP](https://secure.php.net/) >= 5.3.0
43
45
44
46
## Contributions
45
-
Any contributions are welcome!, if you have any questions or suggestions, open an issue.
47
+
Any contributions are welcome!, if you have any questions or suggestions, open an issue.
0 commit comments