-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathdocs.html
More file actions
157 lines (132 loc) · 7.23 KB
/
docs.html
File metadata and controls
157 lines (132 loc) · 7.23 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Profiles for GitHub Developers</title>
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css" rel="stylesheet"
integrity="sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65" crossorigin="anonymous">
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.bundle.min.js"
integrity="sha384-kenU1KFdBIe4zVF0s0G1M5b4hcpxyD9F7jL+jjXkk+Q2h455rYXK/7HAuoJl+0I4"
crossorigin="anonymous"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.2/font/bootstrap-icons.css"
crossorigin="anonymous">
<link href="./general.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/github-dark.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/languages/go.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body data-theme="default" data-layout="fluid">
<div class="row">
<nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
<div class="container-fluid">
<a class="navbar-brand" href="/"> <img src="./bw-logo-sm-reverse.png" width="50rem" height="50rem"> </a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent"
aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation"> <span
class="navbar-toggler-icon"></span> </button>
<div class="collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav me-auto mb-2 mb-lg-0">
<li class="nav-item"> <a class="nav-link" href="./profile.html">Profile</a> </li>
<li class="nav-item"> <a class="nav-link" href="./docs.html">Docs</a> </li>
<li class="nav-item"> <a class="nav-link" href="./about">About</a> </li>
<li class="nav-item"> <a class="nav-link" href="./login">Login</a> </li>
<li class="nav-item"> <a class="nav-link" href="./settings.html">Settings</a> </li>
</ul>
<form class="d-flex">
<input class="form-control me-2" type="search" placeholder="Discover" aria-label="Discover">
<button class="btn btn-outline-success" type="submit">Discover</button>
</form>
</div>
</div>
</nav>
</div>
<div class="wrapper bd-light pt-5 mt-5">
<div class="main">
<main class="content">
<div class="container">
<div class="row pb-2 mt-2 justify-content-md-center">
<div class="col-sm">
<h1 class="text-center">Git started with profiles.dev</h1>
<p class="text-center">You may use profiles.dev by forking a public repo, or using the template repo to create a private repo.</p>
</div>
</div>
<div class="row justify-content-sm-center py-1">
<div class="col-sm text-center">
<ul class="d-flex ps-0 justify-content-center list-group-flush">
<ol class="list-group-item me-3 border-0">
<a class="text-white" href="https://github.com/nomadops/dev-profiles/fork" target="_blank">
<button type="button" class="btn btn-primary border-sm ">
<span class="fs-6">Public Repo</span>
</button>
</a>
</ol>
<ol class="list-group-item border-0">
<a class="text-white" href="https://github.com/nomadops/dev-profiles/generate" target="_blank">
<button type="button" class="btn btn-primary border-sm ">
<span class="fs-6">Private Repo</span>
</button>
</a>
</ol>
</ul>
</div>
</div>
<div class="row justify-content-md-center">
<div class="col-md-8">
<pre class="language-sh text-left rounded">
<code class="text-left rounded">
$ git clone https://github.com/your/dev-profiles
$ brew install pre-commit #optional
$ cd dev-profiles && pre-commit install # optional
# edit profile.json
$ git commit -a -m 'Updated profile' && git push
$ git push
</code>
</pre>
</div>
</div>
<div class="row justify-content-md-center">
<div class="col-md-8 text-center">
<h4 class="rounded pb-3">Integrate your repo with the profiles.dev service</h4>
<a href="https://github.com/apps/profilesdev/installations/new" target="_blank"><button type="button"
class="btn btn-primary btn-lg px-4 gap-3">Install GitHub App</button></a>
</div>
</div>
<div class="row justify-content-md-center mt-5">
<div class="col-md-8 text-left">
<img src="./screenshot.png" class="img-fluid" />
</div>
</div>
<div class="row justify-content-md-center mb-5 mt-5">
<div class="col-md-8 text-left">
<div class="container">
</div>
<h3>How does it work?</h3>
<p>Profiles.dev is a GitHub app which watches for commits to a json file in your dev-profiles repo
<code><a href="https://github.com/nomadops/dev-profiles/blob/main/profile.json">profile.json</a></code>
and renders it as a web page.
</p>
<p>First you put the <a href="https://github.com/nomadops/dev-profiles">dev-profiles repo</a> into your github
account. If everythig in your profile is to be private, you can create a new repo from our <a
href="https://github.com/nomadops/dev-profiles/generate">template repository</a>. For public repos, <a
href="https://github.com/nomadops/dev-profiles/fork">Fork dev-profiles into your account.</a></p>
<p>Next, <a href="https://github.com/apps/profilesdev/installations/new">Install our GitHub App into the
dev-profiles repo.</a> This will send events to our
webhook whenever you commit to the repo. Your account is created when you install this app, and your
profile is created on your first commit.</p>
<p>Now edit <code>profiles.json</code> and push to github.</p> Your account should now be created and your
profile will show at
both <a href="yourprofile.profiles.dev">yourprofile.profiles.dev</a> and <a
href="https://profiles.dev/github/yourprofile">profiles.dev/github/yourprofile</a>.</p>
<p>That's it! Any changes you need to make can be done through git. If you want to delete your account
just go to <a href="https://github.com/apps/profilesdev">our GitHub App</a>, click configure and
uninstall the profiles app. </p>
</div>
</div>
</div>
</main>
</div>
</div>
</body>
</html>