Portfolio

自动生成一个美丽，响应迅速的网站，以显示您的GitHub项目。
shaansubbaiah.github.io的现场演示
如果您发现Portfolio有用，请确保?存储库！

特征

• 网站功能
  • 响应迅速
  • 黑暗模式
  • 灯塔的SEO得分为100
  • 可自定义的颜色，没有。存储库，社交，链接等
  • 支持显示存储库社交预览图像
  • 显示github个人资料readme.md
  • 待办事项：GitHub Gists使用iFrame Embed支持
  • 待办事项：模糊/磨砂玻璃风格的回购卡
• 直接从Portfolio部署到GitHub页面
• 在引擎盖下使用vitejs或建筑物，开发实时预览

入门

安装

1. 克隆回购或下载最新版本

 git clone git@github.com:shaansubbaiah/ Portfolio .git

2. 安装依赖项

Portfolio

npm install\”>

 cd Portfolio

npm install

3. 运行Portfolio

node Portfolio .js

4. 设置github令牌，编辑配置，然后构建！

请参阅配置

可以在https://github.com***/settings/tokens/new上创建一个令牌

确保您选择了Atleast public_repo ，请阅读：创建令牌时用户权限！

5. 您可以从投资组合将网站部署到GitHub页面网站（通常是https：// <your_username> .github.io）。或在dist/ github页面存储库中手动复制内容。

6. 完毕

发展

现在， Portfolio使用ViteJS，可以显着改善现有的开发工作流程。

网站文件在src/

要在更改中使用热线充电查看网站，请运行：

npm run dev

如果缺少数据，则可能必须构建该站点一次，因此将GitHub数据写入./github-data.json

建筑

运行Portfolio并选择构建选项。

在引擎盖下， Portfolio运行vite build ，该构建从vite.config.js读取config，构建文件在dist/

配置

用户名：字符串 – 您的github用户名

存储库：整数 – 要显示的存储库数，最大100

阿凡达：字符串 – 路径（本地/远程）到Avatar和Favicon的图像。如果未指定，请使用您的github avatar。

LinkedInurl ：字符串 – 您的LinkedIn配置文件链接。设置为null在config.json中以禁用IT /在设置时按Enter 。

TwitterID ：字符串 – 您的Twitter配置文件ID。设置为null在config.json中以禁用IT /在设置时按Enter 。 （如果您将其添加到GitHub配置文件中， Portfolio将自动获取您的Twitter ID）

gitlabid ：字符串 – 您的gitlab配置文件ID。设置为null在config.json中以禁用IT /在设置时按Enter 。

navlinks ：对象数组 – 在顶部添加导航链接。不要超过3

 where,
name: String - Text to display
link: String - URL the text links to

Infolinks ：Object Array-在信息部分中添加其他链接。

 where,
name: String - Text to display
link: String - URL the text links to

SocialPreviewImage ：字符串 – 在卡中显示Repo的社交预览图像。要启用，请设置值=“已启用”。

贡献

参见贡献

有关的

gitfolio

开发投资Portfolio

执照

麻省理工学院版权所有（C）2022 Shaan Subbaiah