Skip to content

Latest commit

 

History

History
188 lines (171 loc) · 8.81 KB

CurrentTasks.md

File metadata and controls

188 lines (171 loc) · 8.81 KB

MVP Tasks

  • Website structure
    • Homepage
      • Embedded video
      • CTA
        • Join the Discord
      • Getting Started
      • Features
      • Link to github
  • (MVP) Make mvp demo video and send to Zak

    • Use Obsidian help as sample https://github.com/obsidianmd/obsidian-help/tree/master/en

    • Try to drum up interest with a Discord server / mailing list for a "zero-config digital garden"

    • Video Outline

      • Introduce Eden
        • Highlight that it requires 0 coding knowledge
        • "just alpha at the moment", CTA to join Discord or mailinglist
      • If you're interested in trying the alpha, deno run

    • Video steps

      • The "why", explain the value prop
      • TODO
      • CTA
      • Note: Always assume that a viewer might be seeing any video as their first video so reexplain the core ("this is the deep dive, but there's a simple way to do it if you don't want to customize") every video
  • Website
  • Make it so that --parseDir is the final unnamed argument so you can drag a folder onto the exe to run it on that folder
  • Ensure test image paths works
    • it seems an image can be referenced by name alone unless there are multiple copies
    • If there are multiple copies it references the one at root

Tasks

Bugs

  • Bug: Hidden pages can still show up in backlinks
  • Bug: Pagination order is wonky with top level files
  • Bug: on Features page: ![[Link]] is invisible. its being parsed as an embed even though it's surrounded in single ticks
  • Bug: Spacing is weird in http://localhost:8000/obsidian-flavored-markdown.html Block references (its different from the spacing in the block)
  • Bug: markdown-it thinks that an obsidian embed syntax inside inline-code block is an embed and not code. See names block ids
  • Bug: ignoreDirs does fuzzy matching but should be exact, see tests in os.ts

Enhancements

  • Default first image to thumbnail
  • Rethink if I should copy ALL files to outDir as done in 971a8c1 or just referenced images
  • Remove leading bullet point from checkboxes
  • Simplify js lib so it doesn't have to be stored in a string.
  • Replace all usages of tableOfContents with garden
  • Optimization: What if I just store the lastModified value and skip documents that have been already processed past when they were last modified?
    • I can run Deno.stat on a file about 1500 times in the time it takes to process the file once, so this should be a valid optimization gain
  • Optimize generating backlinks to work on multiple threads
    • For the 4000 md file benchmark, generating backlinks takes a whole 7.7seconds and only runs on 1 core
  • For custom tags like "", I think the best way to parse them is to look for html tags that match a custom formatter.
    • Otherwise it gets real messy parsing nested html tags.
  • Output an rss.xml feed
  • Formatting: Obsidian usually takes a single \n to mean a newline where the current markdown parser will not
  • Allow for commented out content {/* ### Commented out */} that is in the doc but doesn't show
  • Embeddable youtube works with the image syntax:
  • Custom tags could / should be used in the custom transcludable blocks. See tests.md in sample/ for example
  • Metadata inspired by Maggie Appleton
    • content
    • title
    • cover (thumbnail)
    • description
    • growthStage
    • startDate
    • topics
    • type "essay", "note", "etc"
    • updated
    • slug
    • filePath
  • Hide broken image icons
  • Auto url linking (turn urls into links even if they aren't markdown links)
  • Full width images
  • Will this work with other languages? See potential issue in removing by character in extractMetadata()
  • Distinguish between multiple backlinks in the same file (for the sake of linking to the correct one)
  • Support pages that are just backlinks but don't exist as their own page
  • allow for defining different templates than default in a .md's metadata
    • see: // Get default html template
    • Maybe allow for a root template that has boilerplate such as and a specific template that does the rest
  • CLI should only overwrite, never delete the outDir contents
  • Prevent page centering from jumping around when pages switch to scrollbar present/not present
  • Custom index page

Tech Debt

  • // TODO: Make config help text visible to users
  • Warn if a directory is both ignored and included as a static serve directory in config
  • // TODO: Clean up forbidden files, they ruin the JSON
  • Add error reporting
  • Fix hacky way of removing %20 from image urls
  • Handle page titles with parenthesis

Backlog

  • Features to brag about (and to verify first)
    • High Lighthouse + SEO rating
  • Add EULA to executable output
  • Remove manifest
  • feature: Add description for SEO
  • auto embed youtube videos:
<iframe width="560" height="315" src="https://www.youtube.com/embed/VA6zjDN690s" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

Critical Path

  • Finish MVP Features
    • Custom Static Components
      • These will be used to create a homepage and can have custom logic
      • Example: Read more at blah blah blah
        • This will send the content of the xml to a custom js function which will output custom html (like components)
  • Make a 1 minute video showing how it works
  • Test
    • Beta Testers
  • Distribution
    • Pitch: "Powerful, extensible, no-fuss Digital Garden generator"
    • OSS on Github for issues and so people can customize it
    • Sale page on Gumroad for users that want to support
    • Make it runnable without downloading via Deno.run
    • Eventually make it an executable (signed and notorized for macos)
  • Sell MVP
    • Advertise
    • Relevant Sites / Influencers
      • markdownguide.org

User flow

  • If the user runs the program for the first time and there is no config in the directory it should ASK "Would you like to generate a digital garden from the markdown files in {{DIRECTORY}}?"
  • If not, it will ask for a directory path
    • If it cannot find that directory, exit
  • If a directory path is supplied, do nothing

Relevant Links

Competition

Strategy

Eden turns your markdown notes into a beautiful digital garden for publishing online built specifically to work with Obsidian notes. It does not require any configuration and works right out-of-the-box.

Benchmark

https://www.zachleat.com/web/build-benchmark/#benchmark-results

Found using rm -rf ./eden-md-out/my-digital-garden && time ./run.sh

Eden Results:

Results in seconds Note: the folder of 4000 markdown files is about 4MB

# of md files Eden Astro Eleventy Gatsby Hugo
250 0.656 2.270 0.584 14.462 0.071
500 1.031 3.172 0.683 15.722 0.110
1000 2.757 5.098 0.914 17.967 0.171
2000 8.625 9.791 1.250 22.356 0.352
4000 30.020 22.907 1.938 29.059 0.684

This puts Eden at around the same efficiency as Astro