datopian / flowershow

💐 Publish your obsidian digital garden or any markdown site easily and elegantly.
https://flowershow.app/
MIT License
822 stars 97 forks source link

Add user config type #626

Closed homostellaris closed 7 months ago

homostellaris commented 8 months ago

Adds a type for the user config which makes it easier to know what's possible when setting up your own Flowershow instance.

Closes #625

vercel[bot] commented 8 months ago

@homostellaris is attempting to deploy a commit to the Datopian Team on Vercel.

A member of the Team first needs to authorize it.

mohamedsalem401 commented 7 months ago

@homostellaris Thanks a lot for this.🙌 I've reviewed and tested this.

I think it's good to be merged.

mohamedsalem401 commented 7 months ago

@homostellaris The only thing left would be to move this to the right repo, which is https://github.com/datopian/portaljs/blob/main/packages/core/src/config/default.ts, as I don't think those changes should be in Flowershow.

homostellaris commented 7 months ago

@mohamedsalem401 I don't think that would make sense as it's describing the flowershow config which is different to the portal config. You'll notice in siteConfig.ts that where appropriate the portal config types are being referenced but you can also see the additional properties that are specific to flowershow.

If you're worried about the failing build I think that's just due to some upstream changes that I need to include in the config.

homostellaris commented 7 months ago

@mohamedsalem401 the above commit should fix the build error in Vercel.