gitbiome.md(檔案已創建)
| @@ -0,0 +1,105 @@ | |||
| 1 | + | ||
| 2 | + | # gitbiome | |
| 3 | + | ||
| 4 | + | Aggregate your online presences with the help of GitHub! | |
| 5 | + | ||
| 6 | + | - ✅ **Customization**: Choose how your profile is displayed with various theming options | |
| 7 | + | - ✅ **Responsivity**: Your landing page will look great on any device | |
| 8 | + | - ✅ **Easy setup**: Signing up has never been easier as it is unnecessary with our service | |
| 9 | + | - ✅ **Auto-updated data**: Data is dynamically pulled from your GitHub profile | |
| 10 | + | ||
| 11 | + | Check out [our website](https://gitbio.me) to see it yourself. | |
| 12 | + | ||
| 13 | + | ## Creating your profile | |
| 14 | + | ||
| 15 | + | ### Prerequisites | |
| 16 | + | You must publish a GitHub repository named **`gitbio`**, that contains the following files: | |
| 17 | + | - `page.json` | |
| 18 | + | - `readme.md` (optional) | |
| 19 | + | ||
| 20 | + | ||
| 21 | + | Structurally should look like this: | |
| 22 | + | ```bash | |
| 23 | + | ├── gitbio (repository) | |
| 24 | + | │ ├── page.json | |
| 25 | + | │ ├── readme.md # optional | |
| 26 | + | ``` | |
| 27 | + | ||
| 28 | + | **⚠️ The file names are case-sensitive!** | |
| 29 | + | ||
| 30 | + | ||
| 31 | + | ### page.json | |
| 32 | + | This file holds your page configuration, but it must follow a defined convention | |
| 33 | + | ||
| 34 | + | - **`display_name (string)`**: Displayed above your GitHub username | |
| 35 | + | - **`bio (string)`** | |
| 36 | + | - **`platforms (url[])`**: A collection of your social media | |
| 37 | + | - **`showcased_repos (string[])`**: Max. 3 of your repositories to be displayed | |
| 38 | + | - **`show views (boolean)`**: Whether or not to display the views on your gitbio profile. Default is `true` | |
| 39 | + | - **`theme ('light' | 'dark')`**: Theme of your landing profile. Default value is `dark` | |
| 40 | + | - **`background_color (css color)`**: A blurred circle in the background, colored of your choosing | |
| 41 | + | - **`spotify_ws (url)`**: A websocket application endpoint for providing real-time Spotify data. Learn more [here](https://github.com/csehviktor/now-playing?tab=readme-ov-file#now-playing) | |
| 42 | + | ||
| 43 | + | ||
| 44 | + | An example: | |
| 45 | + | ```json | |
| 46 | + | { | |
| 47 | + | "display_name": "john doe", | |
| 48 | + | "bio": "use gitbio.me 😍😘", | |
| 49 | + | "platforms": [ | |
| 50 | + | "https://instagram.com/therock", | |
| 51 | + | "https://yoursit.ee/", | |
| 52 | + | "https://twitter.com/elonmusk", | |
| 53 | + | "random string" // (will not be shown) | |
| 54 | + | ], | |
| 55 | + | "showcased_repos": [ | |
| 56 | + | "gitbio", | |
| 57 | + | "my-repository", | |
| 58 | + | "hello world", // (invalid repo name, therefore will not be shown) | |
| 59 | + | ], | |
| 60 | + | "show_views": true, | |
| 61 | + | "theme": "dark", | |
| 62 | + | "background_color": "#8040ee" | |
| 63 | + | } | |
| 64 | + | ``` | |
| 65 | + | ||
| 66 | + | **Keep in mind!** All of the config keys shown above are optional. Customize your page to your liking. | |
| 67 | + | ||
| 68 | + | ### readme.md | |
| 69 | + | No strict convention, other than file's name being case-sensitive. | |
| 70 | + | ||
| 71 | + | - `README.md` ❌ | |
| 72 | + | - `rEaDmE.md` ❌ | |
| 73 | + | - `readme.MD` ❌ | |
| 74 | + | - `readme.md` ✅ | |
| 75 | + | ||
| 76 | + | ### Your profile | |
| 77 | + | ||
| 78 | + | After creating the repository with the corresponding file(s), your profile will be accessible on `gitbio.me/[username]` or `[username].gitbio.me` | |
| 79 | + | ||
| 80 | + | **Your gitbio username is equivalent to the one on Github** | |
| 81 | + | ||
| 82 | + | ## FAQ | |
| 83 | + | ||
| 84 | + | ### How do I set an avatar and username? | |
| 85 | + | ||
| 86 | + | >You can't. Your avatar and username will be equivalent to the ones on GitHub. | |
| 87 | + | ||
| 88 | + | ### How can I set an icon for my social platform? | |
| 89 | + | ||
| 90 | + | >You can't. Icons are automatically loaded from a preset, according to the origin of your url. External urls are provided with an "external website" icon. | |
| 91 | + | ||
| 92 | + | ### I updated my profile but it won't change on the website. Why? | |
| 93 | + | ||
| 94 | + | >Our service uses cache on loaded values in order to improve load time. It might take a minute or two for changes to take place. In case an error occurs while reading data, it will be shown on your profile page. | |
| 95 | + | ||
| 96 | + | ### How do I delete my profile? | |
| 97 | + | ||
| 98 | + | >You simply delete the repository. | |
| 99 | + | ||
| 100 | + | ### My profile is not working properly in terms of functionality or responsivity. | |
| 101 | + | ||
| 102 | + | >Our service might not be 100%. Issues, pull requests, or even ideas are welcome! | |
| 103 | + | ||
| 104 | + | ## License | |
| 105 | + | [GPL-3.0](https://github.com/csehviktor/gitbiome/blob/main/license) | |
上一頁
下一頁