Alcor Jekyll documentation
Project structure
Where everything lives in Alcor, and which files you'll edit.
Most people only ever edit two files: _config.yml and index.md.
alcor-jekyll/
├── _config.yml Your name, email, availability, profiles, form and footer
├── index.md The home page: a list of sections
├── thank-you.html Where visitors land after sending the form
├── 404.html The "page not found" page
├── _layouts/
│ ├── default.html The HTML shell every page uses
│ └── home.html Header, sections, footer
├── _includes/
│ ├── sections/ One file per section type (hero, services, work…)
│ ├── css/ All the styles, as plain CSS
│ │ ├── theme.css Colours, light and dark
│ │ ├── scale.css Type sizes, spacing, layout widths
│ │ └── sections/ One stylesheet per section type
│ ├── art/ The illustrations (SVG)
│ ├── header.html Name, menu, light/dark switch, button
│ └── footer.html Closing line, profiles, credit
├── assets/
│ ├── fonts/ Instrument Serif (self-hosted)
│ ├── images/ Your photos and the social sharing image
│ └── favicon.svg
└── Gemfile For running the site on your computer
How a page is built
index.md has no text below its front matter. Instead, its sections: list says which sections appear, in which order, with which words. The home layout reads that list and renders each section from _includes/sections/<type>.html.
Only the CSS of the sections a page uses is added to it, and all CSS sits inside the page itself. There’s no separate stylesheet to download.
Files you can delete
.github/workflows/demo.yml: publishes our demo site. It never runs in your copy.jekyll-theme-alcor.gemspec: only needed to build the gem.screenshot.png: the picture in the README.