gic.config.yaml Configuration

This page explains the configuration of gic.config.yaml.

Overall Structure

gic.config.yaml has the following structure:

github:
  username: 'rokuosan'
  repository: 'github-issue-cms'
  labels:
    - 'article'

output:
  articles:
    directory: 'content/posts'
    filename: '%Y-%m-%d_%H%M%S.md'
  images:
    directory: 'static/images/%Y-%m-%d_%H%M%S'
    filename: '[:id].png'
    url: '/images/%Y-%m-%d_%H%M%S'

Configuration Items

github

GitHub settings.

• username: GitHub username
• repository: Repository name to fetch issues from
• labels: Only fetch issues that have all specified labels

output

Output settings.

articles

• directory: Directory to save articles
• filename: Article filename

images

• directory: Directory to save images
• filename: Image filename
• url: Image URL referenced from Markdown

[:id] will be replaced with the image ID. The image ID is unique within each issue and assigned sequentially.

Placeholders

The following placeholders are available in gic.config.yaml:

• %Y: Year
• %m: Month
• %d: Day
• %H: Hour
• %M: Minute
• %S: Second

These placeholders can be used in the same format as strftime.

Configuration Examples

Using Hugo Page Bundles

gic.config.yaml

output:
  articles:
    directory: 'content/posts/%Y-%m-%d_%H%M%S'
    filename: 'index.md'
  images:
    directory: 'content/posts/%Y-%m-%d_%H%M%S'
    filename: '[:id].png'
    url: ''

Output Example