gitnet/www
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

update documentation

Browse source
This commit is contained in:
Simon Vieille 2024-01-23 21:00:25 +01:00
parent b6cfef795a
commit e690b33827
Signed by: deblan
GPG key ID: 579388D585F70417
3 changed files with 60 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
assets/css/app.css
View file

@ -25,3 +25,7 @@ html {
.title:not(:first-child) {
margin-top: 0;
}
.section {
margin-top: 20px;
}

101
index.html
View file

@ -24,62 +24,65 @@
</div>
<div class="container">
<div class="columns">
<div class="column is-one-third is-full-mobile">
<div class="card has-shadow-md">
<div>
<i class="si-rocket has-size-9 has-text-primary"></i>
</div>
<div class="title is-4">1. Set up your repository</div>
<p class="has-text-justify has-mb-4">
Create a public repository named <code>pages</code> to make the site available at the main subdomain.
</p>
<div class="divider"></div>
<p class="has-text-justify has-mb-4">
You can also create a branch <code>pages</code> in an existing repository:
<div class="section is-full-mobile">
<div class="card has-shadow-md">
<div>
<i class="si-rocket has-size-9 has-text-primary"></i>
</div>
<div class="title is-4">1. Set up your repository</div>
<p class="has-text-justify has-mb-4">
Create a public repository named <code>pages</code> to make the site available at the main subdomain.
</p>
<div class="divider"></div>
<p class="has-text-justify has-mb-4">
You can also create a branch <code>pages</code> in an existing repository:
<pre><code>git switch --orphan pages
<pre><code>git switch --orphan pages
# In case if ignored files exist
git rm --cached -r .</code></pre>
</p>
</div>
</p>
</div>
<div class="column is-one-third is-full-mobile">
<div class="card has-shadow-md">
<div>
<i class="si-rocket has-size-9 has-text-primary"></i>
</div>
<div class="title is-4">2. Upload your files</div>
<p class="has-text-justify has-mb-4">
Push your static content, HTML, style, fonts, images or anything else.
</p>
</div>
<div class="section is-full-mobile">
<div class="card has-shadow-md">
<div>
<i class="si-rocket has-size-9 has-text-primary"></i>
</div>
<div class="title is-4">2. Upload your files</div>
<p class="has-text-justify has-mb-4">
Push your static content, HTML, style, fonts, images or anything else.
</p>
</div>
<div class="column is-one-third is-full-mobile">
<div class="card has-shadow-md">
<div>
<i class="si-rocket has-size-9 has-text-primary"></i>
</div>
<div class="title is-4">3. You're done!</div>
<p class="has-text-justify has-mb-4">
Access your new website using this link: <code>https://USERNAME.gitnet.page[/REPOSITORY][/@BRANCH]</code>.
</p>
<p class="text-center"><strong>or</strong></p>
<p>
To use a custom domain, create a file <code>.domains</code> in your repository with the domain name you wish to use.
<br><br>
Then, add a DNS record for that domain:<br>
<code>CNAME [[<i>branch</i>.]<i>repo</i>.]<i>user</i>.gitnet.page.</code>
<br><br>
Or for apex domains where CNAME doesn't work:<br>
<code>ALIAS gitnet.page.</code><br>
<code>TXT [[<i>branch</i>.]<i>repo</i>.]<i>user</i>.gitnet.page</code>
<br><br>
If ALIAS isn't supported, use A instead:<br>
<code>A 193.70.112.230</code><br>
+ <code>TXT</code> as above
</p>
</div>
<div class="section is-full-mobile">
<div class="card has-shadow-md">
<div>
<i class="si-rocket has-size-9 has-text-primary"></i>
</div>
<div class="title is-4">3. You're done!</div>
<p class="has-text-justify has-mb-4">
Access your new website using this link: <code>https://USERNAME.gitnet.page[/REPOSITORY][/@BRANCH]</code>.
</p>
</div>
</div>
<div class="section is-full-mobile">
<div class="card has-shadow-md">
<div>
<i class="si-rocket has-size-9 has-text-primary"></i>
</div>
<div class="title is-4">How to use a custom domain?</div>
<p>To use a custom domain, create a file <code>.domains</code> in your repository with the domain name you wish to use.
Then, add a DNS record for that domain:</p>
<pre>CNAME [[<i>branch</i>.]<i>repo</i>.]<i>user</i>.gitnet.page.</pre>
<p>For apex domains where CNAME doesn't work:</p>
<pre>ALIAS gitnet.page.
TXT [[<i>branch</i>.]<i>repo</i>.]<i>user</i>.gitnet.page</pre>
<p>If ALIAS isn't supported:</p>
<pre>A 193.70.112.230
TXT [[<i>branch</i>.]<i>repo</i>.]<i>user</i>.gitnet.page</pre>
</div>
</div>
</div>

4
src/app.css
View file

@ -25,3 +25,7 @@ html {
.title:not(:first-child) {
margin-top: 0;
}
.section {
margin-top: 20px;
}