Fort Awesome React Github - Shell-Bash

介绍

Fort Awesome React Github - Shell-Bash 是一个基于 React, Github API 和 Shell-Bash 的项目, 可以用于在 Github 上显示项目的 README 文件中的 font awesome 图标.

通过此项目, 用户可以:

• 在项目 README 文件中自由使用 font awesome 图标.
• 通过自定义 Shell-Bash 脚本, 定制自己的图标集合.
• 自动从 Github API 中获取项目信息, 并在页面展示.

使用

在你的项目的 README 文件中, 可以使用以下语法添加 font awesome 图标:

<i class="fa fa-图标名"></i>

比如:

<i class="fa fa-github"></i>

这将会在页面中显示 Github 的图标.

要使用 Fort Awesome React Github - Shell-Bash, 需要进行以下步骤:

1. 安装 npm package:

npm install --save fort-awesome-react-github-shell-bash

2. 在项目中导入并使用组件:

import { FortAwesomeReactGithubShellBash } from 'fort-awesome-react-github-shell-bash';

<FortAwesomeReactGithubShellBash repo="username/repo" />

repo 属性是必须的, 它指定了需要展示的 Github 仓库.

自定义 Shell-Bash

默认情况下, Fort Awesome React Github - Shell-Bash 会自动下载默认的 Shell-Bash 脚本, 并从中获取图标.

如果需要自定义 Shell-Bash 脚本, 可以在组件中使用 iconScript 属性:

<FortAwesomeReactGithubShellBash repo="username/repo" iconScript="https://mycustomscript.sh" />

示例

下面是一个完整的示例, 展示了如何在 Fort Awesome React Github - Shell-Bash 中使用自定义 Shell-Bash 脚本:

import React from 'react';
import { FortAwesomeReactGithubShellBash } from 'fort-awesome-react-github-shell-bash';

const iconScript = `
#!/bin/sh
echo "fa-globe"
echo "fa-clock-o"
echo "fa-bookmark"
`;

function App() {
  return (
    <div className="App">
      <FortAwesomeReactGithubShellBash repo="vuejs/vue" iconScript={iconScript} />
    </div>
  );
}

export default App;

代码片段

import React from 'react';
import { FortAwesomeReactGithubShellBash } from 'fort-awesome-react-github-shell-bash';

const iconScript = `
#!/bin/sh
echo "fa-globe"
echo "fa-clock-o"
echo "fa-bookmark"
`;

function App() {
  return (
    <div className="App">
      <FortAwesomeReactGithubShellBash repo="vuejs/vue" iconScript={iconScript} />
    </div>
  );
}

export default App;