kennethrapp

<p>GitSwag displays data from a Github account using Github’s public API. In order to avoid<br />
rate-limiting, it caches the JSON from the API locally, and refers to that whenever<br />
available. You can display a user profile, list of repositories, header for a single<br />
repository, preview files or gists.</p>
<h3>Administration</h3>
<p>In “GitSwag” under the settings tab, enter your github username, select the<br />
“update cache” checkbox and submit to change your username. Files under that<br />
username can be deleted by checking the box next to the file and submitting.</p>
<p>Any changes you make to your github repo won’t be reflected immediately by<br />
the plugin, you’ll have to manually delete the cache first.</p>
<h3>Composer Updating</h3>
<p>This plugin includes <a href="Composer" rel="nofollow ugc">http://getcomposer.org</a> and an autoloader to implement<br />
the <a href="Parsedown" rel="nofollow ugc">http://parsedown.org/</a> library.</p>
<p>To save a bit of space, composer.phar isn’t included with this plugin.</p>
<p>Parsedown is [https://github.com/erusev/parsedown/blob/master/LICENSE.txt](MIT licensed)</p>
<h3>Shortcode</h3>
<p>Display the profile of a single user<br />
[gitswag_user_view github_username=”username”]</p>
<p>Display a list of repos for a user<br />
[gitswag_repo_list github_username=”username”]</p>
<p>View data for a repository<br />
[gitswag_repo_view github_username=”username” github_repo=”reponame”]</p>
<p>Preview a file<br />
[gitswag_file_view github_username=”username” github_repo=”reponame” path=”path/to/” filename=”file.txt”]</p>
<p>List gists by a user<br />
[gitswag_gist_list github_username=”username”]</p>
<p>Preview a gist<br />
[gitswag_gist_view gist_id=”id”]</p>
<p>display the readme for a repo<br />
[gitswag_readme github_username=”username” github_repo=”reponame”]</p>
<h3>Administration</h3>
<p>Because the public github API is rate limited, this plugin will download and keep a cached<br />
version of the .json files and readme markdown from API calls locally, and will need to be deleted<br />
in the admin panel when a change needs to be reflected. You can select a file and submit to delete them.</p>


GitSwag

Integrate various Github API-driven shortcodes into your pages.

pReya

<p>This is a plugin for WordPress to embed Markdown files from external web sources (e.g. GitHub, GitLab, etc) into WordPress content using the shortcode <code>[external_markdown]</code>. A possible use case for this is to show content from a single source of truth (like a GitHub repository) on your WordPress website.</p>
<h3>Features</h3>
<ul>
<li>Embed any publicly accessible markdown file from other websites</li>
<li>Uses the public and free <a href="https://docs.github.com/en/rest/reference/markdown" rel="nofollow ugc">GitHub API</a> to transform Markdown to HTML (there is a rate limit – so don’t overdo it)</li>
<li>Caching support (so you can configure how often the file is being fetched from the source – default is a <strong>once per hour</strong> maximum)</li>
<li>Customise the CSS class of the markdown container to adjust styles</li>
</ul>
<h3>Instructions / Examples</h3>
<p>Download and unpack or clone this repository into your <code>wp-content/plugins</code> folder, so the PHP file resides in <code>wp-content/plugins/external-markdown/external-markdown.php</code>.</p>
<p>If you use the Guttenberg editor, you need to add a “Shortcode” block first. If your’re using the classic editor, you can use the shortcode right away.</p>
<h4>Simple embed</h4>
<p>The <code>url</code> parameter takes the URL to the Markdown file you want to embed. Make sure to <a href="#attention-when-using-github-gitlab-etc" rel="nofollow ugc">use the “raw” URL when you use GitHub, GitLab, etc</a>.<br />
    <code>[external_markdown url="https://raw.githubusercontent.com/pReya/wordpress-external-markdown/main/README.md"]</code></p>
<h4>Adjust caching duration</h4>
<p>The <code>ttl</code> parameter controls how long the cached version is used, before it’s fetched again. The value is given in seconds. So 24 hours (24* 60 *60) result in a value of 86400.<br />
    <code>[external_markdown ttl=86400 url="https://raw.githubusercontent.com/pReya/wordpress-external-markdown/main/README.md"]</code></p>
<h4>Adjust container CSS class</h4>
<p>The <code>class</code> parameter takes your desired class name for the external markdown container. The default class name for the container is <code>class='external-markdown'</code>.<br />
    <code>[external_markdown class="my-classname" url="https://raw.githubusercontent.com/pReya/wordpress-external-markdown/main/README.md"]</code></p>
<h4>Attention when using GitHub, GitLab, etc.</h4>
<p>When embedding content from Git hosting services like GitHub or GitLab, you need to make sure to use the proper “raw” markdown URL. You can find this URL in the upper right corner of the web view.</p>
<h3>Attribution</h3>
<ul>
<li>This plugin was inspired by the great <a href="https://wordpress.org/plugins/documents-from-git/" rel="ugc">wordpress-markdown-git</a> plugin, which serves a similar purpose, but uses the Git provider APIs to fetch the raw Markdown files – which is a little more complicated than this approach here.</li>
</ul>


External Markdown

Working well

This is a plugin for Wordpress to embed Markdown files from external web sources (e.g. GitHub, GitLab, etc) into WordPress content.

GitSwag vs External Markdown