Skip to content

Commit 9652260

Browse files
author
Igor Alexey
authored
Update README.md
1 parent b520d84 commit 9652260

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<h1 align="center">TinyDocs</h1>
22
<img src="https://img.shields.io/github/license/vortexdevsoftware/tiny-wiki"> <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/vortexdevsoftware/tiny-wiki/total">
33
<p align="center">
4-
<img src="favicon.png" width=64 />
4+
<img src="https://github.com/vortexdevsoftware/tinyDocs/assets/18470725/4b84b2aa-d1c9-4eb9-8eb4-332809fc5a79" width=500 />
55
</p>
6-
<p align="center">Flat-file CMS engine with search</p>
7-
<sub align="center">And maybe editing in the future</sub>
6+
<p align="center">Flat-file CMS engine with search<br><sub>And possibly editing in the future</sub></p>
87

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
1010

1111
## Why use TinyDocs?
1212
Are you looking for a simple way to document anything?
@@ -18,6 +18,8 @@ Are you looking for a simple way to document anything?
1818
4. 🧩 **Scalable**: *TinyDocs* provides a scalable solution, allowing your documentation to grow and expand as needed to accommodate changes and additions.
1919
5. 📝 **Documented**: Everything that you would want to change is documented in the source code.
2020

21+
Live example: https://docs.vortex-dev.com
22+
2123
## Modules
2224
*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
2325

@@ -39,7 +41,7 @@ In order to configure TinyDocs you will need to upload the files to your web ser
3941
5. Add your Markdown files to the pages/ directory, organizing them into folders if you wish to create categories.
4042

4143
## Dependencies
42-
* [PHP](https://secure.php.net/) >= 5.3.0
44+
* [PHP](https://secure.php.net/) >= 5.3.0
4345

4446
## 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

Comments
 (0)