SinglePaged

SinglePaged is a free Jekyll template for building a single-page website where each vertical section is an editable markdown file, designed for project pages, resumes, and event sites.

What is SinglePaged?

SinglePaged is a Jekyll-powered single-page site template created by t413. It takes markdown files stored in the _posts directory as input, along with _config.yml settings, and outputs a static HTML page with vertical sections. Each section defines its own background color, text color, title, and optional Font-Awesome icon. The template is designed to run on GitHub Pages without any additional build steps.

Key Features

• Markdown-based sections — Each vertical section is a separate markdown file in _posts/, sorted by date, so adding or reordering sections is just file management.
• Per-section styling — Front matter in each post sets bg (a key from _config.yml or a quoted HTML color), color for text, and fa-icon for any Font-Awesome icon.
• Two-file configuration — The only files you need to edit are _config.yml for site title, description, keywords, and markdown posts for content.
• Built-in integrations — SEO terms, favicon, and Google Analytics token are configured through _config.yml.
• Three deployment modes — Set up as a user homepage at username.github.io, a standalone project page at username.github.io/repo, or inside an existing project via an orphan gh-pages branch.
• Local preview — Install Jekyll with the github-pages gem and run jekyll serve -w to preview at localhost:4000 before pushing.

Who is it for?

• Open-source maintainers — Showcase a project with a polished landing page, as done for Mockito, argon.js, and Coala Analyzer.
• Academics and researchers — Present a course, lab, or field of study, like the Bioinformatics at Harvard Medical School page.
• Job seekers — Build a single-page resume or portfolio, such as those listed in the README for UX designer Lia Bogoev and particle physics lecturer Michael A. Schmidt.
• Event organizers — Create pages for conferences and hackathons, including CodeWeek 15 and Open CoMo.

What can you do with SinglePaged?

• Project teasers — Launch a coming-soon page for a product like Zeno or Physical.media.
• Personal events — Design wedding invitation pages, as seen with Karen and Scott's site.
• Educational resources — Build a class or workshop page with sections for schedule, topics, and resources.
• Team or organization hubs — Create a site for a user group or community like Alt.Net Australia or PHP Cat.

How does SinglePaged work?

Start by forking the repository and choosing a setup mode. Add markdown files to _posts/ with YAML front matter for title, background, text color, and Font-Awesome icon. Edit _config.yml to set site title, description, and SEO or analytics settings. Run jekyll serve -w locally to preview, then push to the appropriate GitHub Pages branch to publish.

FAQ

How do I get started with SinglePaged?

Fork the repository on GitHub, rename it according to your chosen setup mode, clone it, and switch to the publish branch. For a user homepage, rename to username.github.io and set master as default; for a project page, rename freely and use gh-pages.

Can I use custom colors in SinglePaged?

Yes. In each post's front matter, set bg and color to either a quoted HTML color like '#0fbfcf' or a key defined in the colors section of _config.yml.

What do I need to run SinglePaged locally?

Install Jekyll with the command sudo gem install github-pages, then run jekyll serve -w. Your site will be available at localhost:4000. Changes to _config.yml require a manual restart of the server.

How do I update SinglePaged?

Add the original repository as a remote named singlepage, fetch it, then merge or rebase the publish branch into your current branch. For a standalone or existing page use git merge singlepage/publish; for a user homepage use the same on the master branch.

Is SinglePaged free to use?

Yes, it is publicly available on GitHub and can be forked without charge.