WP Manifestindependent plugin directory
manifest / integrations / azrcrv-get-github-file

Get GitHub File

Get GitHub File ClassicPress plugin

by azurecurve · github.com/azurecurve/azrcrv-get-github-file · website

★ 1stars
1forks

Install

No release zip yet. The repository archive installs, but the folder name will carry the branch suffix and updates will not flow:

wp plugin install https://github.com/azurecurve/azrcrv-get-github-file/archive/refs/heads/master.zip
Readme github.com/azurecurve/azrcrv-get-github-file ↗

Get GitHub File

Plugin Banner

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: