[epic] Flowershow MVP v0.1

[rufuspollock]

Working app that is useable enough to power the website of flowershow itself so that we can validate the approach

• Key aspect is the template
• Command line is nice but secondary

Acceptance

• flowershow repo ✅2022-07-01 or earlier
• default template working ✅2022-07-12 it is working
• flowershow.app running off that default template ✅2022-07-20 all done. See https://flowershow.app/

Dogfooding the app

• Have a front page and other pages use markdown ✅2022-07-12 have lots of page e.g. https://flowershow.app/docs
• Nice landing page (still powered by markdown) ✅2022-07-20 all working. See Default theme v0.1 #23 for screenshot etc.

Features

• tailwind support
• Markdown support
• MDX support
• Basic site config
• Basic theme e.g. navbar and footer 🚧2022-07-12 what do we mean by this? configuration thereof?
• Analytics - google - this could be first test for componentization (or maybe just live with default for now)
• Docs and Raw layout 🚧2022-07-12 DONE but needs proper documentation

Bonus:

• SEO support
• theme customization

Pre-questions

• Do we try and do in component/compositional way or just do all in one for now? ✅2022-06-22 go all in one route though compositional where we can
  • Work out how we do adding stuff if we go that route.
• Do we work in portal.js repo or in new flowershow? ✅2022-06-22 go for flowershow as one repo for one thing and we can have site alongside

Tasks

• Boot the repo
• Add a stub README
• Create templates directory
• Have standard base template e.g. https://github.com/datopian/portal.js/tree/main/examples/nextjs-tailwind-mdx
  • Upgrade old nextjs-tailwind-mdx app to use contentlayer #3

Dogfood a bit - boot the flowershow website using the template

try to do it all in markdown (or close to!)

• symlink templates/default into .flowershow/templates directory
  • What about siteConfig type stuff though
• Then set content directory as path ../../ ✅2022-06-24 actually because of symlink setup in our case did ../../site/ -- that's ok and in all other cases would be ../../
  • and make sure that contentlayer ignore .xxx directories when searching for content. ✅2022-06-24 it doesn't ignore them
  • 🐛 need to make sure contentlayer does not pick up .flowershow folder in a content directory. ✅2022-06-24 Fixed by using https://www.contentlayer.dev/docs/reference/source-files/make-source#contentdirexclude and explicitly excluding it
• Being able to set the home page
  • Remove default pages/index.js as will conflict with real index page
  • Want index.md picked up as "index" file for a folder
  • (?) Want README.md picked up as index file for a folder ❌2022-06-24 WONTFIX for now as not that important. More for compatibility with eg. github viewer etc

Landing page (nice)

Asides / Bonus

• What about assets folder? => have to symlink into flowershow
• customizable layouts per markdown page?? (future?) Configurable layouts for pages #8
• How do we do config overriding?? Several options. Most basic and standard is environmental variables. Config can be overridden by user #7 ❌2022-07-12 WONTFIX for now as painful. Rather use convention over configuration. Everything is in content folder.
• How do we expose config variables to markdow pages 🚧2022-07-12 this is the same as MDX support including components and data #20 issue about data passing. For now we defer this
  • for the mdx system we are using how do we insert variables into the scope of the page ... ✅2022-07-12 Same as previous point

Notes

Rufus

• Treat "site" like a project a user would create => content at the root??
  • could make things a bit easier for ourselves by still having content in a subdirectory??
• There is some advantage to "one level of indirection" even if that indirection is inside flowershow setup
  • Why? Because nextjs is kind of picky about where stuff goes as is contentlayer e.g. js files have to be in pages directory, contentlayer doesn't allow us to do (what??)

Layout of site (template for project sites)

Inside site/

# this will even be symlinked in our case
# in normal cases would be installed (via git even so easy to upgrade)
.flowershow/templates/default  # not touched by user (so we can keep changing)
.flowershow/content

index.md
my-other-file.md
my-directory/index.md => my-directory (not my-directory/index)
my-directory/abc.md 

# if i'm using obsidian ... this needs to end up in public
assets/

[rufuspollock]

FIXED. Everything is done! Couple of non-essential things left e.g. SEO which moved to own issue plus MDX item which is in progress.