Skip to content
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

Quickstart Howto for Using Flowershow as website template #586

Open
3 tasks
rufuspollock opened this issue Oct 26, 2023 · 2 comments
Open
3 tasks

Quickstart Howto for Using Flowershow as website template #586

rufuspollock opened this issue Oct 26, 2023 · 2 comments
Assignees
Labels

Comments

@rufuspollock
Copy link
Member

rufuspollock commented Oct 26, 2023

From @olayway in a thread on discord

  1. clone the repo
  2. add any of your markdown files to /content folder
  3. run npm run dev or npm run export && npm run start
  4. (optional) configure your site with /content/config.mjs file (see available options here: https://flowershow.app/docs/config and in feature specific docs pages https://flowershow.app/docs)
  5. (optional) If you want to embed assets, you need to put them in some folder iside the /content folder (e.g. /content/assets) and create a symlink to that folder in /public under the same name (here assets)

NB: we have this old (may be a bit out of date) tutorial https://flowershow.app/blog/2023-02-16-nextjs-tutorial

Acceptance

  • Instructions for how to do this
  • Tried out
  • Documented somewhere good (e.g. docs/website-quickstart?)
@rufuspollock rufuspollock self-assigned this Oct 27, 2023
@davidgasquez
Copy link

davidgasquez commented Oct 27, 2023

Would be cool to run Flowershow from npm a la Astro/Eleventy/Evidence (npm create astro/eleventy/evidence@latest && npm run dev). Smooth way to get something up without messing with git!

EDIT: The command I'm looking for might be already in the docs!

npx create-next-app@latest --example https://github.com/datopian/flowershow

@rufuspollock
Copy link
Member Author

@davidgasquez yes i think that command should "just work". So maybe we just need to document that really clearly ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: 🏗 In progress
Development

No branches or pull requests

2 participants