Skip to content
Invisible link to canonical for Microformats

My project starter

An open source project with a clear starting point

Source code Get started

This annotated example shows home-page source and sample content from project. It runs inside the documentation site, using this site’s skin and configuration; it is not the standalone example’s home page. The full folder includes its own Gemfile and _config.yml, with no publishing workflow.

For preparation, preview and publication, follow Run and publish a starter example.

Home-page header

---
layout: landingpage
title: My project
subtitle: Explain what your project helps people do
header_type: hero
project_links:
  - label: Source code
    icon: fab fa-github
    url: https://github.com/username/project
  - label: Get started
    icon: fas fa-book
    url: "#getting-started"
---

The source above is the standalone site’s index.md, so its button targets the home-page section. This documentation demo uses /demo/starter-project#getting-started for its own button to reach the same sample section without leaving the demo.

Home-page content

The sections below are sample copy for the fictional project. The Get started button jumps to that sample section; use the starter setup guide to prepare the website itself.

What you can build

Describe a concrete task that your project makes easier. Include an example of the result and who it is for.

Getting started

  1. Download or install the project using your own installation instructions.
  2. Run the smallest useful example.
  3. Link to your project’s documentation and support channels.

Contributing

Replace the source-code URL above and explain how people can contribute.

Site configuration

# Edit title, description, repository, url and baseurl before publishing.
remote_theme: dieghernan/chulapa
# The default branch includes development features. Append @TAG to pin a release.
title: My project
description: An open source project with a clear starting point
repository: username/site
url: https://username.github.io
baseurl: /site
locale: en-US
plugins:
  - jekyll-remote-theme
  - jekyll-include-cache
  - jekyll-github-metadata
  - jekyll-paginate
  - jekyll-sitemap
exclude: [Gemfile, Gemfile.lock, README.md, vendor]
kramdown:
  input: GFM
chulapa-skin:
  skin: flatly
navbar:
  brand:
    title: My project
  nav:
    - title: Home
      url: /