Skip to content

Commit 3716636

Browse files
committed
Rewrite Getting Started; move GS to Intro
0 parents  commit 3716636

File tree

148 files changed

+19931
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

148 files changed

+19931
-0
lines changed

.editorconfig

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[*]
2+
end_of_line = lf
3+
insert_final_newline = true
4+
5+
[*.{md,css,js,html}]
6+
indent_style = tab
7+
indent_size = 4

.github/FUNDING.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: mholt
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_gitignore/

Caddyfile

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
localhost
2+
3+
root * src
4+
5+
file_server
6+
templates
7+
encode gzip
8+
9+
try_files {path}.html {path}
10+
11+
redir /docs/json /docs/json/
12+
redir /docs/modules /docs/modules/
13+
rewrite /docs/json/* /docs/json/index.html
14+
rewrite /docs/modules/* /docs/modules/index.html
15+
rewrite /docs/* /docs/index.html
16+
17+
reverse_proxy /api/* localhost:4444

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The Caddy Website
2+
=================
3+
4+
This is the source of the Caddy website, [caddyserver.com](https://caddyserver.com).
5+
6+
7+
## Requirements
8+
9+
- Caddy 2 (installed in your PATH as `caddy`)
10+
11+
12+
## Quick start
13+
14+
1. `git clone https://github.com/caddyserver/website.git`
15+
2. `cd website`
16+
3. `caddy run`
17+
18+
Your first time, you may be prompted for a password. This is so Caddy can serve the site over local HTTPS. If you can't bind to low ports, change [the address at the top of the Caddyfile](https://github.com/caddyserver/website/blob/master/Caddyfile#L1), for example `localhost:2015`.
19+
20+
You can then load [https://localhost](https://localhost) (or whatever address you configured) in your browser.
21+
22+

src/account/create.html

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Create Account - Caddy</title>
5+
{{include "/includes/account/head.html"}}
6+
<script src="/resources/js/account/create.js"></script>
7+
</head>
8+
<body>
9+
<form action="/api/create-account" class="card">
10+
<section class="head">
11+
<a href="/"><img src="/resources/images/caddy-lock.png" alt="Caddy Portal" class="logo"></a>
12+
</section>
13+
<section>
14+
<h1>Create Account</h1>
15+
or <a href="/account/login">log in</a>
16+
<div class="form-fields">
17+
<input type="text" name="name" id="name" placeholder="Name">
18+
<input type="email" name="email" id="email" placeholder="Email address" required>
19+
<input type="password" name="password" placeholder="Password" required>
20+
<button type="submit" id="submit" class="blue">Create Account</button>
21+
<p>
22+
We will send you an email to verify your account.
23+
</p>
24+
</div>
25+
</section>
26+
</form>
27+
</body>
28+
</html>

src/account/index.html

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Dashboard - Caddy</title>
5+
{{include "/includes/account/head.html"}}
6+
<link rel="stylesheet" href="/resources/css/account/dashboard.css">
7+
<script src="/resources/js/account/dashboard.js"></script>
8+
</head>
9+
<body>
10+
<div class="container">
11+
{{include "/includes/account/nav.html"}}
12+
<main class="dashboard">
13+
<section>
14+
<h1 class="pad">Your packages<a href="/account/register-package" class="gray button float-right">Register package</a></h1>
15+
<table id="user-packages">
16+
<tr>
17+
<th>Import path</th>
18+
<th class="text-center"><span class="help" title="Whether package and module documentation is visible on the website.">Listed</span></th>
19+
<th class="text-center"><span class="help" title="Whether visitors can download Caddy with this package plugged in.">Available</span></th>
20+
<th>Downloads</th>
21+
<th></th>
22+
</tr>
23+
<!-- Filled by JS -->
24+
</table>
25+
<!-- <div class="text-right pad">
26+
<a href="/account/register-package" class="gray button">Register package</a>
27+
</div> -->
28+
</section>
29+
</main>
30+
</div>
31+
</body>
32+
</html>

src/account/login.html

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Log In - Caddy</title>
5+
{{include "/includes/account/head.html"}}
6+
<script src="/resources/js/account/login.js"></script>
7+
</head>
8+
<body>
9+
<form action="/api/login" class="card">
10+
<section class="head">
11+
<a href="/"><img src="/resources/images/caddy-lock.png" alt="Caddy Portal" class="logo"></a>
12+
</section>
13+
<section>
14+
<h1>Log In</h1>
15+
or <a href="/account/create">create account</a>
16+
<div class="form-fields">
17+
<input type="email" name="email" id="email" placeholder="Email address" required>
18+
<input type="password" name="password" placeholder="Password" required>
19+
<button type="submit" id="submit" class="blue">Log In</button>
20+
<a href="/account/reset-password">Reset password</a>
21+
</div>
22+
</section>
23+
</form>
24+
</body>
25+
</html>

src/account/logout.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Logout - Caddy</title>
5+
{{include "/includes/account/head.html"}}
6+
<script src="/resources/js/account/logout.js"></script>
7+
</head>
8+
<body>
9+
Logging out...
10+
</body>
11+
</html>

src/account/register-package.html

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Register Package - Caddy</title>
5+
{{include "/includes/account/head.html"}}
6+
<script src="/resources/js/account/register-package.js"></script>
7+
</head>
8+
<body>
9+
<div class="container">
10+
{{include "/includes/account/nav.html"}}
11+
<main>
12+
<section>
13+
<form action="/api/claim-package">
14+
<div class="form-fields">
15+
<div class="field">
16+
<label>
17+
<b>Package import path</b>
18+
<input type="text" name="package" required>
19+
</label>
20+
<div class="description">
21+
You must use <a href="https://github.com/golang/go/wiki/Modules#semantic-import-versioning" target="_blank">semantic import versioning</a>. Basically, this means if your module is at v2 or higher the import path must be suffixed with <b>/vN</b> (where <b>N</b> is the major version number).
22+
</div>
23+
</div>
24+
<div class="field">
25+
<label>
26+
<b>Version</b>
27+
<input type="text" name="version" placeholder="latest">
28+
</label>
29+
<div class="description">
30+
Optional. Any version string recognized by <a href="https://github.com/golang/go/wiki/Modules#version-selection">Go module</a> tooling is acceptable.
31+
</div>
32+
</div>
33+
<div class="text-center">
34+
<button type="submit" id="submit" class="blue">Claim Package</button>
35+
</div>
36+
</div>
37+
</form>
38+
</section>
39+
</main>
40+
</div>
41+
</body>
42+
</html>

0 commit comments

Comments
 (0)