tachyons-bootstrap.dwyl.com Documentation

1. Project Overview & Quickstart (dwyl/tachyons-bootstrap.dwyl.com) Copy Chapter

tachyons-bootstrap.dwyl.com

Open-source repository dwyl/tachyons-bootstrap.dwyl.com

Repository Details Copy Section

• Repository: dwyl/tachyons-bootstrap.dwyl.com
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (dwyl/dwyl.github.io) Copy Chapter

File: README.md Copy Chapter

*Welcome* to the dwyl website! [](https://github.com/dwyl/dwyl-site/actions)

It's as ever a work in progress, so please don't hesitate to
share your ideas
on how to make it better!

The current site was designed by
@harrygfox
and built by
@Cleop,
@ZooeyMiller
&
@finnhodgkin.

You can see the original Invision slides here :sparkles:

How? Copy Chapter

Technology Copy Chapter

Hosted on GitHub Pages with Cloudflare for SSL

Functional CSS with Tachyons :heart:

Hop over to learn-tachyons to find out
how we use functional css to power our website.

Javascript

We've kept JS to a minimum on the site, using it only when required to
enhance UX, and taking every care to ensure that it
gracefully degrades
for users with JavaScript disabled.

Viewing locally Copy Section

With Live Reload

To view the site locally, execute the following two commands:

git clone [email protected]:dwyl/dwyl-site.git & cd dwyl-site
python3 -m http.server

Then open your web browser to: http://localhost:8000

Accessibility Copy Section

The site meets WCAG 2.0 Level A for accessibility. Please
raise an issue if you notice any
accessibility problems!

Cloudflare setup Copy Section

We're using the Cloudflare free tier to serve dwyl.com over https.

To add your own account head over to cloudflare.com
and sign up for an account. Add your custom domain and wait while Cloudflare
scans your domain setup. Once that's done you'll need to add the Cloudflare
nameservers to your own DNS.

Changes involving nameservers can sometime take time, so if something isn't
working straight away just be patient and come back to it later.

Adding SSL

GitHub page don't provide https access to custom domains, so we use Cloudflare
to reroute requests through their secure server. Hop over to the Crypto tab of
the Cloudflare control panel and change SSL to flexible:

To force the site to always redirect http requests to https add a page rule:

Adding subdomains

dwyl.com has three subdomains all set up in a slightly different way.

Google form redirect - one subdomain on dwyl.com just redirects to a Google
form. First add a general CNAME record:

Then add a page rule to redirect to the specific URL:

A name subdomain - hits.dwyl.com is added via a standard A
name record:

GitHub pages subdomain - tachyons-bootstrap.dwyl.com
is hosted via GitHub pages. There's a slightly more complicated setup process
for subdomains hosted in this way which is explained well in this guide.

How do I add myself to the team page? Copy Section

You'll need to copy and past this block of code, replace your details where
noted, and paste it at the bottom of the team section (just before the closing
<section> tag, with a comment ``) in team.html.

<label for="YOUR-NAME" class="pointer">
    
    YOUR-NAME
    YOUR-JOB-ROLE
  </label>
  
    <a href="https://github.com/YOUR-GITHUB-HANDLE" class="mr3 link dwyl-bg-yellow br-100 center w2 h2 dib">
      YOUR-NAME's GitHub
      
    </a>
     
    <a href="https://twitter.com/YOUR-TWITTER-HANDLE" class="ml3 link dwyl-bg-yellow br-100 center w2 h2 dib">
      YOUR-NAME's Twitter
      
    </a>
    
      YOUR-SELF-DESCRIPTION-(50-100 words)

File: _home/README.md Copy Chapter

Huh...?

This directory contains the script that generates the home.html file
in the root of the repository.

To run the script you will need to be connected to the internet
as it will "scrape" the README.md of: https://github.com/dwyl/home

node _home/compile.js

You should see:

done.

(if you see anything else, please try to debug it locally,
and if you're still scratching your head, open an issue on GitHub!)