Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Markdown Blog Post Import / Sync - Serve the blog post content from a markdown directory

オープン
#484 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
28/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
csharp, markdown

調査の方向性

まず BlogPost エンティティと NCronJob.IJob エントリポイントを読み、次に appsettings.json と UpgradeAssistent のマイグレーション領域を確認します。さらに、この issue では markdown インターフェースのドキュメント化も求められています。提案されたフラットディレクトリからのインポート、メタデータの処理、ExternalId の追跡、設定、マイグレーション、ドキュメントがすべて定義および実装されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

The current state of the blog is: Users write Markdown inside the blog post and the blog renders this to the enduser to HTML.

An obvious automation for that is that we introduce a background job that monitors (via NCronJob.IJob) a directory/repository/... and automatically imports them into the blog. That allows the blog post as a vehicle, but authoring/versioning happens via GitHub for example.

The question is, how should we get certain metadata:

  • Via folder structure
  • One markdown with a header section
  • A Mix of both?

My current way of thinking is the second option, as we also need some way of having a unique ID in the markdown file in case users change the title and we can't associated markdown file to the blog post in the blog itself. It might look something like:

----------
id: some-string-that-has-to-be-unique
title: Here comes the title
tags: tag 1, tag 2
image: https://some-image.url/image.webp
fallbackimage: https://some-image.url/fallback-image.jpg
published: true
----------
The first block is the Short Description that allows arbitrary Markdown
----------
The second block is the Content that allows arbitrary Markdown

The "interface" has to be well documented in our docs. Our BlogPost entity needs the new ExternalId as property to keep track of the source.

The configuration of the target will happen in the appsettings.json file and we need a new migration for the UpgradeAssistent. We may want a new section like:

{
  "markdownImport": {
    "sourceType": "GitHub",
    "url": "https://github.com/...."
  }
}

For starters we can begin with a flat directory as this doesn't need any additional packages and knowledge about the source. So for example url would be https://github.com/linkdotnet/blog-source/main/md/ and in there would be all files, which we would parse from top to bottom in alphatical order.

主要言語
C#
スター
428
フォーク
95
平均マージ
3分
マージ済み PR(30日)
7

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

linkdotnet/Blog のほかの issue

linkdotnet/Blog の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。