Get GitHub File

Description

Gets the content of a file from a GitHub repository and outputs using the [github-file] shortcode.

Settings allow default options, such as author, folder, filename to be specified. Additional options to allow the removal or conversion of WordPress headers in readme.txt files.

Available shortcode parameters:

• account - account on GitHub
• branch - branch to get file from
• folder - folder containing the file
• file - file to get from GitHub repository
• repository - name of GitHub repository
• startfrom - text in file to start outputting from (e.g. # Description)
• htmlastext - 1 to output HTMl as text and 0 to output as HTML
• shortcodesastext - 1 to output shortcodes as text and 0 to output as shortcode
• wordpresstitles - remove/ignore/convert

All parameters except repository can be defined as defaults in settings.

Example shortcode usage:

[github-file branch="master" repository="azrcrv-get-github-file"]

Output is in markdown, but use of a plugin such as Markdown by azurecurve can convert this markdown to HTML markup.

This plugin is multisite compatible; settings need to be configured for each site.

Installation Instructions

• Download the latest release of the plugin from GitHub.
• Upload the entire zip file using the Plugins upload function in your ClassicPress admin panel.
• Activate the plugin.
• Configure relevant settings via the configuration page in the admin control panel (azurecurve menu).

About azurecurve

azurecurve was one of the first plugin developers to start developing for Classicpress; all plugins are available from azurecurve Development and are integrated with the Update Manager plugin for fully integrated, no hassle, updates.

The other plugins available from azurecurve are:

• Add Open Graph Tags - details / download
• Add Twitter Cards - details / download
• Avatars - details / download
• Breadcrumbs - details / download
• Call-out Boxes - details / download
• Code - details / download
• Comment Validator - details / download
• Conditional Links - details / download
• Contact Forms - details / download
• Disable FLoC - details / download
• Display After Post Content - details / download
• Estimated Read Time - details / download
• Events - details / download
• Filtered Categories - details / download
• Flags - details / download
• Floating Featured Image - details / download
• Gallery From Folder - details / download
• Get GitHub File - details / download
• Icons - details / download
• Images - details / download
• Insult Generator - details / download
• Load Admin CSS - details / download
• Loop Injection - details / download
• Maintenance Mode - details / download
• Markdown - details / download
• Mobile Detection - details / download
• Multisite Favicon - details / download
• Nearby - details / download
• Page Index - details / download
• Post Archive - details / download
• Redirect - details / download
• Remove Revisions - details / download
• RSS Feed - details / download
• RSS Suffix - details / download
• Series Index - details / download
• Shortcodes in Comments - details / download
• Shortcodes in Widgets - details / download
• Sidebar Login - details / download
• SMTP - details / download
• Snippets - details / download
• Strong Password Generator - details / download
• Tag Cloud - details / download
• Taxonomy Index - details / download
• Taxonomy Order - details / download
• Theme Switcher - details / download
• Timelines - details / download
• Toggle Show/Hide - details / download
• Update Admin Menu - details / download
• URL Shortener - details / download
• Username Protection - details / download
• Widget Announcements - details / download