Skip to content

03. Setup

Scott J edited this page Sep 11, 2019 · 27 revisions

Edit default site config

# set site name, URL, description, etc
.app/setup.sh

# load settings
source .site_config

# run the 'httpd' web server (if you prefer a different web server, you can use that instead)
server start

If you change anything in .site_config, you should rebuild your site so all your pages get the latest change/values, and then re-publish:

rebuild -all
publish "updated site"

Variables in .site_config

After running .app/setup, the .site_config file will contain the following variables, among others:

$site_title

The main name/title of your site - it appears at the top of the page and in your sites meta info.

$site_url

  • If your site is https://user.github.io/mdsh/, use $site_url='/mdsh'
  • if your site is http://site.com/blog/, use $site_url='/blog'.
  • if your site is http://site.com/, use $site_url=''.

$site_js_deps

A space separated list of npm packages to include in all pages by default. Example:

cash-dom fetch-polyfill
  • Uses Unpkg.com to provide the packages.
  • Supports npm/semver naming like [email protected].
  • Use the following format for package names: package[@version/file]

In other words, only the package name is needed. See http://unpkg.com for more info.

$site_fonts

A Google Font request. Leave blank if you don't want to use Google Fonts. The default value is:

Ubuntu:400,400i,700|Inconsolata:400,400i,700|Monaco:400,400i,700&subset=latin,latin-ext

$site_author

Your name. Appears in site meta data and as author of blog posts (unless overridden when writing the blog post).

$site_email

This email is used by the auto-generated contact form (contact.html). (Some basic spam protection is provided by using Javascript and Formspree.io to send the submitted data to your given email).

$site_twitter

Your Twitter handle - appears under the main headings of your site posts. Useful to encourage users to share your content on Twitter or visit your Titter page.

$site_code_highlight_theme

Choose the code highlighting theme used by Pygments.
Can be set to any of these values:

  • monokai
  • monokai-osx (nice, fuzzy border shadows)
  • default
  • emacs
  • github
  • perldoc
  • vs
  • autumn
  • colorful
  • fruity
  • solarized-dark
  • solarized-light
  • trac
  • vim

You can add or edit these Pygment themes in assets/css/pygments-<theme-name>.css

Many of these themes are WCAG AA accessible (high-contrast) themes :)

Clone this wiki locally