TODO.md

Chert Site TODO

Welcome to your new Chert site! If you're already familiar with Chert and its various interfaces, feel free to ignore or delete this file, otherwise hopefully it proves a useful guide!

Starting

• Read the README.md in this directory for an introduction to the directory structure of a Chert site.
• Run git init or other version control initialization commands in the directory containing this TODO.
  • Tweak the included .gitignore if need be.
  • Perform your first git commit!
• Set the title, tagline, and author name in config.yaml
  • Update the links with the relevant social media stuff
• Update the README, including the name and date in the copyright notice at the bottom
• Update the name and date in the LICENSE file (or choose a non-BSD license)

Authoring

• Put any non-entry media, such as graphics and photos under the uploads directory
• Write a new entry under the entries directory
  • Markdown reference: https://guides.github.com/features/mastering-markdown/
  • YAML reference: https://en.wikipedia.org/wiki/YAML#Sample_document
• After you've got a basic post, view it by running chert serve in the same directory as this TODO. Whenever you edit your post, hit save and then refresh your browser to see the new version.
• Update the entries/about.md special entry with information about you.

Customizing

• Put custom behaviors in custom.py
• Optionally change the development server port/ip under the dev section of config.yaml
• Tweak the theme under the theme directory
  • Dust references: http://akdubya.github.io/dustjs/ & https://github.com/linkedin/dustjs/wiki/Dust-Tutorial

Publishing

• Procure a web server with SSH access
• Save the relevant details (host, username, path) under the prod section of config.yaml
• Set up Google Analytics and put your UA-XXXXXX-X code in config.yaml
• Set up SSH keys
  • Reference: https://www.digitalocean.com/community/tutorials/how-to-set-up-ssh-keys--2
• Ensure rsync is installed on the local machine
  • run which rsync or just try running rsync
• Run chert publish
• Create a new Github Issue letting the Chert maintainer know that there's another Chert site. Definitely do this step if you've customized Chert in any way, either via custom.py or a new theme. Community thrives on variety! Thanks for using Chert!