Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.83 KB

README.md

File metadata and controls

32 lines (22 loc) · 1.83 KB
Raw

Idea Repo Template

A simple approach to creating and managing product ideas (locally, via Markdown).

Create a new note via the cli with bin/newIdea.sh

Notes

  • Stores ideas in Markdown files (one file per idea)
  • Create a new idea via bin/newIdea.sh
  • Hugo-like CLI creation of new files (credit for idea)
  • New ideas are created from a template (to help with consistency and efficiency in hashing-out the idea)
  • Adjust the default idea template to your needs and preferences (it's /archetypes/idea-template.md)
  • Uses a file-naming structure for ideas ((i){filename}.md) for grouping in file-explorer UIs and searchability
  • View (i)example.md to see the initial file created from the idea-template archetype
  • Easily create new templates and shell commands based on the existing (for other types of ideas, e.g. a top-based "thinking" file)
  • Remember to make each bin/* file executable (e.g. chmod 0755 bin/newIdea.sh)

Tips / Considerations

  • If you're on MacOS, install QLMarkdown to quickly view rendered Markdown via quick look (e.g. press space in finder when file is selected, use arrows to switch to different files)
  • Use with Obsidian (might be obsolete if using specific plugins/workflows in Obsidian)
  • Use a local Markdown server to view ideas in your browser (e.g. Madness, md-fileserver, markserv)

Enhancement Considerations

  • Make the CLI more sophisticated (though the simplicity is refreshing)
  • Would "templates" be a better name than "archetypes"?

Questions/Thoughts/Feedback/Etc/Etc?

Reach out on Twitter: @jaymakes11