-
Notifications
You must be signed in to change notification settings - Fork 329
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
[site/blog][s]: markdowndb launch post #1036
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
8 Ignored Deployments
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really good - and i've got some suggestions to make it awesome. hope you find feedback useful and always feel free to take or not.
@@ -0,0 +1,39 @@ | |||
--- | |||
title: Announcing the official launch of MarkdownDB! 🚀 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest:
Announcing MarkdownDB: {Insert summary of what it is}
Why? because title is strongest thing we have - thing headline in a newspaper.
E.g.
Announcing MarkdownDB: an open source tool to create an SQL API to your markdown files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree!
@@ -0,0 +1,39 @@ | |||
--- | |||
title: Announcing the official launch of MarkdownDB! 🚀 | |||
description: We're excited to announce the official launch of MarkdownDB, an open library to transform markdown content into SQLite database. And now, it has a dedicated website at markdowndb.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"We're excited" is boilerplate 😄 Let's trim. "official" is boilerplate etc. We also can reuse what we have in the hero. So how about:
Announcing MarkdownDB, an open source library to transform markdown content into sql-queryable data. Get a rich SQL API to your markdown files in seconds. Build rich markdown-powered sites easily and reliably. New dedicated website at markdowndb.com
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree, just removing this part - Get a rich SQL API to your markdown files in seconds. - as it's already stated in the title.
description: We're excited to announce the official launch of MarkdownDB, an open library to transform markdown content into SQLite database. And now, it has a dedicated website at markdowndb.com | ||
date: 2023-10-11 | ||
authors: ['Ola Rubaj'] | ||
filetype: 'blog' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does the filetype
do anything? I've not found it working on files outside of blog directory?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can be removed
|
||
Hello, dear readers! | ||
|
||
We're excited to announce the official launch of MarkdownDB, an open library to transform markdown content into SQLite database. And now, it has a dedicated website! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
here we can be excited 😉
We're excited to announce the official launch of MarkdownDB, an open source library to transform markdown content into sql-queryable data. Get a rich SQL API to your markdown files in seconds and build rich markdown-powered sites easily and reliably.
We've also create a new dedicated website:
|
||
## 🔍 What is MarkdownDB? | ||
|
||
MarkdownDB transforms your Markdown content into a queryable, lightweight SQLite database. Imagine being able to treat your collection of markdown files like entries in a database! Ever thought about fetching documents with specific tags or created in the past week? Or, say, pulling up all tasks across documents marked with the "⏭️" emoji? With MarkdownDB, all of this (and more) is not just possible, but also a breeze. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👏
Small tweak at end:
is not just possible, but a breeze.
- Lightweight and fast indexing 1000s of files in seconds. | ||
- Open source and extensible via plugin system. | ||
|
||
## 🚀 Quick start |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest:
🚀 How it works
|
||
## 🚀 Quick start | ||
|
||
1. Start with a collection of markdown files. These could be your blog posts, project docs, or any other type of content. Each file can be enhanced with a YAML frontmatter to include metadata. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be kind of nice to just screenshot the sections from the front page here and use the same text. I think it is worth it and useful for historical purposes (one day the markdowndb front page will have changed).
So what i mean is something like:
### You have a folder of markdown content
For example, your blog posts. Each file can have a YAML frontmatter header with metadata like title, date, tags, etc.
{Insert screenshot i.e.}
etc etc
|
||
--- | ||
|
||
Explore the world of MarkdownDB on [our new official website](https://markdowndb.com/) and support us on [GitHub](https://github.com/datopian/markdowndb). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggest
Find out more on our new official website: https://markdowndb.com/
Check out the source on GitHub https://github.com/datopian/markdowndb
(Why: where links are informative and useful i think it is worth including them in full as they are here - then i know where i am going if i click on them etc)
@olayway and please just merge once you have acted on feedback (or not) so we keep this moving rapidly 😄 |
No description provided.