Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a blog post about markdowndb computed fields #2

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mohamedsalem401
Copy link
Contributor

No description provided.

Copy link
Contributor

@olayway olayway left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't read the whole piece, but I can already tell this needs some more work. After reading the introduction I have no idea what this tutorial is even about. There should be a clear problem statement and how it can be solved with mddb. I think you should 1) focus on the message you're trying to convey 2) only then focus on making it sound "cool" or "engaging". Try to convince me/the user:

  1. that he has a problem
  2. that we can solve this problem and show him how

@@ -0,0 +1,127 @@
# Building a website with markdown: extract data from markdown Files with markdownDB

Let's face it, keeping your website content organized can be a challenge. When you rely on Markdown files, extracting titles or description efficiently for an index page can feel like a chore. But fear not! Here's where MarkdownDB comes in to save the day.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There 4 sentences don't make sense to me:

  • extract data from markdown Files with markdownDB
  • keeping your website content organized can be a challenge
  • When you rely on Markdown files, extracting titles or description efficiently for an index page can feel like a chore
  • A Smoother Workflow for Your Content

There is no logical flow to it. And by the end of the 4th sentence I still have no idea what is this tutorial about. I'm only more confused.


**A Smoother Workflow for Your Content:**

1. **Prepare Your Content Files:** Your Markdown files are the building blocks. Feel free to include a YAML frontmatter section at the beginning to store metadata like title, date, tags, and more. Here's an example:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, not sure why this sentence is even here: "Your Markdown files are the building blocks"

And I'm not sure what I'm doing at this point anyway...

@rufuspollock
Copy link
Member

@olayway could we do a small bit of polishing and get this published ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants