GitXplorerGitXplorer
g

website

public
1 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
4f40759b30677a54ce22c90545f3a67bbf56ecbb

A few fixes.

ggbrls committed 5 years ago
Unverified
7f55323d7476e74d06defb2016c84073d9d50d4d

Minor fixes

ggbrls committed 5 years ago
Unverified
a6ae6aa3d9b840ae67d51cb5b70a8535385f8602

Garbage collection

ggbrls committed 5 years ago
Unverified
8618badd7fc71a8128e6a094fecee8462bdff319

New post

ggbrls committed 5 years ago
Unverified
72c0171dfffc4b76f25db10cb70ed5b36ca622e8

typos

ggbrls committed 5 years ago
Unverified
36cde61e027e49098f069b072d37c8c0b56a88ba

Typo

ggbrls committed 5 years ago

README

The README file for this repository.

Hugo-flex theme example

This is an example from scratch using hugo-flex theme. Hugo-Flex is a JavaScript-free theme with Google PageSpeed 100. This is important for having a really fast website without using AMP. We have built a top 100,000 website (https://www.scivision.dev) using hugo-flex.

Static site generators like Hugo build an arbitrarily simple or complex website from:

  • simple Markdown .md syntax in the content/posts directory
  • images and other files under static/ directory
  • static pages like about.md go in content/ directory

Images, Twitter tweets, YouTube videos, etc. are inlined via Hugo shortcodes.

Configuring

  1. Install Hugo
  2. Make a copy of this template repo by clicking the Use this Template button. git clone your copy to your laptop and change to that directory.
  3. Run Hugo and point your web browser to http://localhost:1313
    hugo server
  4. Edit the website configuration in config.toml (or config.yaml). You may have to restart hugo server if you make major changes.

Deploying

Note:

  • in the following discussion replace "username" with your GitHub username.
  • in config.toml, be sure "baseUrl" is set for your username/reponame or it will not deploy correctly.

You can build and deploy to Github Pages. For advanced / higher traffic pages (1 million + views/year) you might consider Netlify. Most individual users can simply use GitHub Pages.

deploy Hugo to GitHub Pages

For GitHub Pages with Hugo, build the HTML on your laptop.

One-time: configure GitHub Pages Settings for your repo to have Source: "master branch /docs folder".

Each time website is updated, from the top-level website repo directory:

  1. Build site, with HTML output to docs/ per config.yaml:
hugo --source .
  1. Add changes to git.
git add docs
  1. Commit changes.
git commit -m "updated website"
  1. Push site to GitHub Pages
git push

Browse to https://username.github.io/hugo-flex-example to see your demo site.

When satisfied with the demo site, rename the repository to username.github.io and then your visitors can simply browse https://username.github.io

Domain name

To have your web address be https://janedoe.example or similar, you must purchase a domain name (from Google Domains for example) and then configure DNS to point to https://username.github.io

Private history

To keep the configuration and history of your website private, you can set the webpage GitHub repo to be "Private", while deploying a public webpage. This is recommended as in some cases, Google and other search engines will show the website Git repo in the search results alongside the actual desired website.