Skip to content

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
    • Help
    • Support
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
files_readmemd
files_readmemd
  • Project
    • Project
    • Details
    • Activity
    • Releases
    • Cycle Analytics
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Charts
  • Issues 3
    • Issues 3
    • List
    • Boards
    • Labels
    • Milestones
  • Merge Requests 0
    • Merge Requests 0
  • Wiki
    • Wiki
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Charts
  • Create a new issue
  • Commits
  • Issue Boards
  • uncloud
  • files_readmemdfiles_readmemd
  • Wiki
  • Home

Home

Last edited by Matthieu Le Corre Nov 25, 2019
Page history

Files README.md

Show README.md & HEADER.md gitlab style on your NextCloud !

With this app you can add a header and a footer to your nextcloud directories. This can be use to explain the goal of a directory, describe the content of a folder ...

It show README.md in the way gitlab does.

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 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.

  • 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
  • Task list : markdown-it-task-lists
  • Code highlight : markdown-it-highlightjs

Admin section

There is a new admin section in settings letting you tweak README.md

  • You have now some appearance options
  • Multi rendering engine are available
  • You can choose which filenames are to be used for header/footer content.

Releases

  • 1.0.0 files_readmemd.tgz
  • 1.0.1 files_readmemd.tgz
  • 1.0.2 files_readmemd.tar.gz
  • 1.0.3 files_readmemd.tar.gz
  • 1.0.4 files_readmemd.tar.gz
  • 1.1.0 files_readmemd.tar.gz
  • 1.1.1 files_readmemd.tar.gz
  • 1.1.2 files_readmemd.tar.gz
  • 1.1.3 files_readmemd.tar.gz
Clone repository
  • Home
More Pages