Markdown Blog Post Import / Sync - Serve the blog post content from a markdown directory
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 428
- Forks
- 95
- Avg merge
- 3m
- Merged PRs (30d)
- 7
Description
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
- [x] 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:
```markdown
----------
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:
```json
{
"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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the BlogPost entity and the NCronJob.IJob entry point, then inspect appsettings.json and the UpgradeAssistent migration area. The issue also calls for documenting the markdown interface. Done means the proposed flat-directory import, metadata handling, ExternalId tracking, configuration, migration, and documentation are all defined and implemented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, markdown
- Domain
- backend, database, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100