-
Notifications
You must be signed in to change notification settings - Fork 17
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
[epic] MarkdownDB site (landing page) and "launch" #1
Comments
@rufuspollock here is what I have so far: https://hackmd.io/Vjs2nusSQF6B0qEfTA0tMg |
@olayway great start. I think we can start with something like this and just iterate - let not the best be the enemy of the good 😄 |
Notes from discussion just now: https://link.excalidraw.com/l/9u8crB2ZmUo/RVethZITOO
|
Reviewed in standup. Key points:
|
@rufuspollock I've updated the README with some content from the landing page and added some basic API reference as well. |
FIXED. Site is up https://markdowndb.com and we've done some posting. |
Landing page / launch announce
Objective: can announce the "idea" and prototype on e.g. hacker news
I'm imagining we 3 pieces of core content (which could be posts/pages in themselves) which then inform the main front page
🚩 I'm not convinced doing this so thoroughly is necessary. Maybe we can just have a rough landing page and flesh out detailed post later 😉 /cc @olayway
Acceptance
Announce
Tasks
2023-10-11
Minor additions
Built with ❤️ by Datopian
in footer and at bottom of Hero2023-10-04
2023-10-07
Quickstart text
You have a folder of markdown content e.g. some blog posts
Install markdowndb (optional)
Index the files using markdowndb
mddb
Query our files: get a list of all our blog posts with their titles
A bit more interesting: query just featured blog posts
Use in your application with framework your of choice [show js code using this in e.g. getStaticProps]
[optional] Running app with blog posts or list of projects (reuse our screenshot ...)
Notes
Inspirations perhaps for landing pages
These aren't all as relevant (some we just like layout or approach vs actual info architectuve)
Landing page v1 copy
Hero section
Title 1: The missing API/interface from your markdown files to a blog/digital garden/notion alterantive/...
Title A:
Welcome to MarkdownDB - your next-level content base. 🔥🔥
Title B:
Unlock the potential of Markdown as data.
Title C:
Reimagining Markdown's potential with MarkdownDB.
...
Subtitle A:
Combine the simplicity of Markdown with the capabilities of a database. 🔥
Subtitle B:
From Markdown files to a rich, queryable database in a snap. 🔥🔥 👈👈
Subtitle C:
Elevate your markdown files. Create, extend, and extract with MarkdownDB.
[DEMO gif or side-by-side screenshots of md files opened in e.g. Obsidian and indexed in the db]
Features / Why MarkdowbDB
Power of plain text: Combination of unstructured content and structured data in simple Markdown files. With MarkdownDB, you no longer have to compromise between the ease of writing in Markdown and the functionality of a full-fledged database.
Simplicity at core: Turn your Markdown files into a queryable, lightweight SQL database.
Flexible and extendabile: Bring your own document types, extend your frontmatter with computed fields and check for errors with with custom validations.
Simple API: Get a list of all or some Markdown files, filter them by frontmatter fields, and more.
Do one thing well 😉 markdowndb just gives you a database, an API a super-powerful and extensible way to create those from markdown. We don't provide a UI, live editing of values etc ... (though others may do!)
Open source: Your content isn’t locked away in proprietary platforms. It’s open, it's free, it’s yours.
Not tied to any stack: Use anywhere you want - NextJS, SvelteKit, from the command line etc etc.
Images and other assets as well as text
MarkdownDB the Pattern - why use markdown to create a database/collections
Power of plain text: Combination of unstructured content and structured data in simple Markdown files. With MarkdownDB, you no longer have to compromise between the ease of writing in Markdown and the functionality of a full-fledged database.
Open source/formats
Combined Structured and unstructured information
Images and other assets as well as text
Roadmap
Phase 1 - Basic Implementation:
Phase 2 - Advanced Features:
Phase 3 - Optimization:
The vision
Unified Content Management
Imagine a world where Markdown isn’t just text - it’s an entry in a database, it's a source of structured and unstructured data. With MarkdownDB, we aim to balance the simplicity and accessibility of writing in Markdown with the ability to treat your collection of markdown files like a database (think Notion) - allowing, for example presenting each markdown file in a folder as a row in a sheet (e.g. for a project list or any other kind of collection), think querying your markdown files like a database e.g. show me documents with a created in the last week with "hello world" in the title or show me all tasks in all documents with "⏭️" emoji in the task (indicating it's next up!)
How does it work?
Extract: From frontmatter, links, tasks, and more - data extraction is comprehensive and intuitive.
Index: Effortlessly index a folder of markdown files and transform them into structured databse records.
Query: Utilize the simple API to query your content. Whether you’re creating an individual page, generating a tag list, or referencing backlinks, MarkdownDB has got you covered.
[See It in Action]: Dive into our demo video that walks you through how MarkdownDB transforms the familiar markdown syntax into a rich, interactive database. You'll witness how effortlessly you can extend, embed, and extract content, all with the foundational simplicity of Markdown.
CRF
Old taglines use on github:
MarkdownDB is a pattern and toolkit for using markdown to store collections of stuff. Think a simple open source Airtable or spreadsheet alternative.
The text was updated successfully, but these errors were encountered: