內容簡介
WP Github Gist WordPress 插件提供了在您的博客文章或頁面中嵌入 Github Gist 和文件的功能。雖然 Github 沒有提供一種嵌入文件的方式,不過這個插件仍然可以使用 gist-it 服務。
特色
嵌入 Gist
要嵌入 Gist,您需要使用以下簡碼:
[gist id="{GIST_ID}" file="{GIST_FILE}" width="{WIDTH}" height="{HEIGHT}"]
以下是簡碼中可用的不同屬性:
id - 您的 Gist ID。
file - 要顯示的 Gist 內部文件。如果 Gist 中只有一個文件,則可以忽略此項。
width - 代碼包裝器的寬度。默認為 100%。
height - 代碼包裝器的高度。默認為 100%。
例如:[gist id="12345" file="myfile" width="100%" height="100%"]
嵌入 Github 文件
要嵌入 Github 文件,您需要使用以下簡碼:
[github file="{GITHUB_FILE}" start_line="{START_LINE}" end_line="{END_LINE}"]
{GITHUB_FILE} - 您的 Github 文件的完整路徑。例如:如果您想要嵌入 https://github.com/sudar/MissileLauncher/blob/master/MissileLauncher.cpp,那麼 {GITHUB_FILE} 將是 /sudar/MissileLauncher/blob/master/MissileLauncher.cpp
{START_LINE} - 如果您只想嵌入文件的一部分,可以指定起始行號(可選)
{END_LINE} - 如果您只想嵌入文件的一部分,可以指定結束行號(可選)
例如:[github file="/sudar/MissileLauncher/blob/master/MissileLauncher.cpp"]
如果您只想嵌入文件的一部分,可以指定開始和結束行號
[github file="/sudar/MissileLauncher/blob/master/MissileLauncher.cpp" start_line="10" end_line="20"]
更改 Gist-it 服務器
默認情況下,此插件使用我的自己的gist-it 服務器,該服務器托管在免費的 Google App Engine 帳戶上。如果您的網站預期會有大量訪問量,您可以考慮使用自己的 gist-it 服務器。您可以按照 這些指示部署您自己的 gist-it 服務器,然後轉到設置頁面更改 URL。
翻譯
插件附帶了 POT 檔。如果您愿意為插件做翻譯,請使用 POT 檔創建您語言的 .po 文件並告訴我。我會在給予您信用後添加到插件中。
支援
可以從 插件主頁獲得插件的支援。如果您有任何問題或建議,請在那裡留下評論或聯繫我(Twitter)。
Readme 生成器
此 README 文件是使用 wp-readme 生成的,這是一個為 WordPress 插件生成 README 文件的工具。
外掛標籤
開發者團隊
原文外掛簡介
WP Github Gist WordPress Plugin, provides the ability to embed gist and files from Github in your blog posts or pages. Even though Github doesn’t provide a way to embed files, this Plugin still works by using the gist-it service.
Features
Embed Gist
To embed a gist you have to use the following shortcode
[gist id = "{GIST_ID}" file = "{GIST_FILE}" width = "{WIDTH}" height = "{HEIGHT}"]
The following are the different attributes that you can use in the shortcode
id – Id of your gist.
file – File inside gist that you want to display. If there is only one file in the gist, then you can ignore this.
width – Width of the code wrapper. Default is 100%.
height – Height of the code wrapper. Default is 100%.
eg: [gist id = "12345" file = "myfile" width = "100%" height = "100%"]
Embed Github files
To embed a github file you have to use the following shortcode
[github file = "{GITHUB_FILE}" start_line = "{START_LINE}" end_line = "{END_LINE}"]
{GITHUB_FILE} – full path to your github file. eg: If you want to embed https://github.com/sudar/MissileLauncher/blob/master/MissileLauncher.cpp then {GITHUB_FILE} would be /sudar/MissileLauncher/blob/master/MissileLauncher.cpp
{START_LINE} – If you want to embed only part of the file, then you can specify the starting line number (optional)
{END_LINE} – If you want to embed only part of the file, then you can specify the ending line number (optional)
eg: [github file = "/sudar/MissileLauncher/blob/master/MissileLauncher.cpp"]
if you want to embed only part of the file, then you can specify the start and end line as well
[github file = "/sudar/MissileLauncher/blob/master/MissileLauncher.cpp" start_line = "10" end_line = "20"]
Changing Gist-it server
By default, this Plugin uses my own gist-it server which is hosted on a free Google App Engine account. If you expect significant amount of traffic to your blog, then do consider using your own gist-it server. You can follow the instructions to deploy your own gist-it server and then go to the settings page to change the url.
Translation
The pot file is available with the Plugin. If you are willing to do translation for the Plugin, use the pot file to create the .po files for your language and let me know. I will add it to the Plugin after giving credit to you.
Support
Support for the Plugin is available from the Plugin’s home page. If you have any questions or suggestions, do leave a comment there or contact me in twitter.
Readme Generator
This Readme file was generated using wp-readme, which generates readme files for WordPress Plugins.
