... | ... | @@ -9,12 +9,13 @@ This can be use to explain the goal of a directory, describe the content of a fo |
|
|
It show README.md in the way gitlab does.
|
|
|
|
|
|
|
|
|
# Usage
|
|
|
Usage
|
|
|
|
|
|
* Create a README.md file (case sensitive name) and fill it with the apropriate Markdown content.
|
|
|
* You can do the same with the HEADER.md file.
|
|
|
* It's rendered using the same markdown engine as the apps. Before file list for the HEADER.md, after file list for the README.md
|
|
|
* It's rendered using the same markdown engine as the app. Before file list for the HEADER.md, after file list for the README.md
|
|
|
* You can now use .README.md & .HEADER.md .It means that you can now hide those files.
|
|
|
* You can also use .markdown extention.
|
|
|
* It render now in public shared !
|
|
|
|
|
|
Now you can use template to customize the README.md/HEADER.md rendering.
|
... | ... | @@ -22,10 +23,21 @@ Now you can use template to customize the README.md/HEADER.md rendering. |
|
|
* Create your own theme and use your own content.css (see css/content.css file)
|
|
|
* Rendering is done inside a div contenair with headermd or readmemd class.
|
|
|
|
|
|
# Markdow enabled plugins
|
|
|
|
|
|
The following markdown plugins are available, more to come, fill a issue if you need more.
|
|
|
|
|
|
* Image sizing : [markdown-it-imsize](https://www.npmjs.com/package/markdown-it-imsize)
|
|
|
* Task list : [markdown-it-task-lists
|
|
|
](https://www.npmjs.com/package/markdown-it-task-lists)
|
|
|
* Code highlight : [markdown-it-highlightjs](https://www.npmjs.com/package/markdown-it-highlightjs)
|
|
|
|
|
|
|
|
|
# Releases
|
|
|
* 1.0.0 [files_readmemd.tgz](uploads/ed4149d5f0933715f235f48e0ae9738a/files_readmemd.tgz)
|
|
|
* 1.0.1 [files_readmemd.tgz](uploads/c6d7ca216f0cfd14f79acdd931c2db4e/files_readmemd.tgz)
|
|
|
* 1.0.2 [files_readmemd.tar.gz](uploads/727823d01a822ceb2a4540b380be837c/files_readmemd.tar.gz)
|
|
|
* 1.0.3 [files_readmemd.tar.gz](uploads/e4bdb1591caa5b195d941c7d053c0f1a/files_readmemd.tar.gz)
|
|
|
* 1.0.4 [files_readmemd.tar.gz](uploads/9036dcae59eb21ebe19b90b41d3c8b76/files_readmemd.tar.gz)
|
|
|
|
|
|
|