Create your site's configuration file
The `_config.yml` file in your new community archive site sets a bunch of display information automatically, from your site's title to your font and color choices.
This form will generate and save a `_config.yml` file for you that you can upload to your new GitHub site.
var ConfigYMLTemplate = ` ############################################## # START YOUR CONFIGURATION HERE! For more info, visit https://digitalarcplatform.kalanicraig.com/quickstart #--------------------- # THEME. Leave Lines 4-6 alone. #--------------------- remote_theme: kalanicraig/digitalarcplatform@1.0.0 repository: 'REPONAME' # change this to your repository name ############################################## # WHAT IS ALL THIS STUFF? #--------------------- # _config is easy. Most web sites have configuration files. # .yml means YAML. It's the data that runs your site. # Some files, like this one, are entirely made up of YAML. # Lines with information that isn't YAML are commented out; the lines start with # # Those lines will be ignored by the computer but provide important information to you. # ############################################## # WHAT DO I DO NOW? #--------------------- # Look for the lines that have a bunch of ### in row. # These break _config.yml into sections. # You'll need to do something slightly different in each section. # If you see an instruction to "comment out", add a # to the beginning of the line(s). # If you see an instruction to "uncomment", remove the # at the beginning of the line(s). ############################################## # THE MOST IMPORTANT THING TO REMEMBER #--------------------- # Variables are the things that drive your site. # In YAML, there's a variable name--a placeholder--at the beginning of the line. # Variables have colons after them in YAML. # After the variable comes the actual contents of the variable, usually in double quotes # title: "Your Site Title" # If you use another double quote inside your variable, it will break this config file. # title: "My "So-Called" Website" # ############################################## # START CUSTOMIZING YOUR SITE HERE ############################################## # ABOUT YOUR SITE #--------------------- # Title of your website title: "SITETITLE" # Subtitle of your website. Leave blank if you want to. subtitle: "SITESUBTITLE" # A longer description of your site (max 150 words). Helps search engines find you. description: "SITEDESCRIPTION" # These credits show up in the includes/_footer.html # Main author of the website. author: "SITEAUTHORSHORT" authorname : "SITEAUTHORFULL" # To change the photo on your homepage, open the assets folder in your Github repo, then open the img folder. Upload a photo there. Add only the name of the photo and its extension here. E.g. "alternate_logo.png") # Main author of the website. sitelogo: "site_logo.png" # What year did you start up this community project? sitedate : SITEDATESTART # Other community social media. Leave blank if you don't have these. email : "SITEEMAIL" website : "SITEWEBSITE" twitter : "SITETWITTER" github : "SITEGITHUB" facebook : "SITEFACEBOOK" instagram : "SITEINSTAGRAM" # If you need to know how many people visit your site, go to https://analytics.google.com/ # When you finish the setup assistant, it will give you a Measurement ID: G-ABCDEFGHIJ google_g4_analytics_id: SITEGOOGLEANALYTICSG4 ############################################## # FONTS AND COLORS #--------------------- # Choose the FONTS you'd like to use. # You can see these font choices in action at https://digitalarcplatform.kalanicraig.com/docs/ # Uncomment the line for the font you like. Comment out all of the other lines. #fontchoice: archivonarrow # A narrow sans-serif font for headlines and body text #fontchoice: baloo # A clean sans-serif font with a playful rounded sans-serif accent #fontchoice: quattrocento # A modern sans-serif font with classic serif accents #fontchoice: raleway # An elegant sans-serif font with bold sans-serif accents #fontchoice: roboto # A clean sans-serif font with simple serif accents #fontchoice: slab # A funky slab font with clean sans-serif accents #fontchoice: source # A modern serif font with clean sans-serif accents fontchoice: SITEFONTCHOICE # Choose the COLORS you'd like to use. # You can see these color choices in action at https://digitalarcplatform.kalanicraig.com/docs/ # Uncomment the line for the color you like. Comment out all of the other lines. #colorchoice: navy # Navy with bright teal and grey #colorchoice: leafgreen # Leafy green and medium brown #colorchoice: tan # Tan and deep brown with flame-bright orange #colorchoice: teal # Bright teal with bright orange-yellow accents #colorchoice: marigold # Near-black with marigold yellow #colorchoice: red # Black, crimson and grey #colorchoice: lavenderred # Purple-grey with orange-red #colorchoice: dusk # Dusky purple and olive green colorchoice: SITECOLORCHOICE ############################################## # ORGANIZING YOUR COLLECTION #--------------------- # These collections take the basic files you put together for each item in your collection and auto-group and display them. # This takes each item in your archive collection and displays it collections: items: output: true permalink: /:collection/:path:output_ext contributor: true creator: true group: true reception: output: true permalink: /:collection/:path:output_ext # If your collection items need to be grouped by person, family or some other group, uncomment this collection # groups: # output: true # permalink: /:collection/:path:output_ext # name: true # folder: true # sort_by: folder # If you have oral histories that go with groups, uncomment this collection: # oralhistories: # output: true # permalink: /:collection/:path:output_ext # name: true # folder: true # sort_by: folder authors: output: false name: true ############################################## # WEBSITE ORGANIZATION #--------------------- # MOST OF THESE THINGS DON'T NEED TO BE CHANGED. ############################################## # This URL is the main address for absolute links. This will usually be blank. url: # If this archive will be in a folder (kalanicraig.com/digitalarcplatform/) instead of in its own main site (digitalarcplatform.github.io) add that folder name here. This will usually be blank. Use a forward slash before the folder name but not after, like so baseurl: '/foldername' baseurl: # This URL points directly to the images directory. It needs a slash at the end. # # Example:
# Markdown-Example for posts 
#
urlimg: '/assets/img/'
urlitemimg: '/assets/items/'
urlreceptionimg: '/assets/reception/'
permalink: /:categories/:year/:month/:day/:title:output_ext
markdown : kramdown
syntax_highlighter: rouge
# This URL points directly to the images directory. It needs a slash at the end.
exclude :
- Gemfile
- Gemfile.lock
- CNAME
- LICENSE
- README.md
- INSTALL.md
- vendor/bundle
include: ['_pages']
sass:
sass_dir: _sass
style: compressed
plugins:
- jekyll-seo-tag
`;
function startDownload() {
// access the text from the input fields
var formEl = document.forms.Config;
var formData = new FormData(formEl);
var find = ["REPONAME", "SITETITLE", "SITESUBTITLE", "SITEDESCRIPTION", "SITEAUTHORSHORT", "SITEAUTHORFULL", "SITEEMAIL", "SITEWEBSITE", "SITETWITTER", "SITEGITHUB", "SITEFACEBOOK", "SITEINSTAGRAM", "SITEGOOGLEANALYTICSG4", "SITEFONTCHOICE", "SITECOLORCHOICE"];
var replace = [document.getElementById("site_repo").value, document.getElementById("site_title").value, document.getElementById("site_subtitle").value, document.getElementById("site_desc").value, "SITEAUTHORSHORT", document.getElementById("site_owner").value, document.getElementById("site_email").value, document.getElementById("site_website").value, document.getElementById("site_twitter").value, document.getElementById("site_github").value, document.getElementById("site_facebook").value, document.getElementById("site_instagram").value, document.getElementById("site_googleg4").value, document.getElementById("fontchoice").value, document.getElementById("colorchoice").value];
String.prototype.replaceArray = function(find, replace) {
var replaceString = this;
for (var i = 0; i < find.length; i++) {
replaceString = replaceString.replace(find[i], replace[i]);
}
return replaceString;
};
ConfigYMLTemplate = ConfigYMLTemplate.replaceArray(find, replace);
// Create dummy element using JavaScript.
var hidden_a = document.createElement('a');
// add texts as a href of element after encoding.
hidden_a.setAttribute('href', 'data:text/plain;charset=utf-8, '+ encodeURIComponent(ConfigYMLTemplate));
// also set the value of the download attribute
hidden_a.setAttribute('download', "_config.yml");
document.body.appendChild(hidden_a);
// click the link element
hidden_a.click();
document.body.removeChild(hidden_a);
}