docs/config

[giscus[bot]]

docs/config

Flowershow supports setting common configuration values using a config.mjs file in your content directory. With it you can customize some things like website title, navigation links in the navbar, or ...

https://flowershow.app/docs/config

[nyejon]

Is it possible to get a list of all config options please?

[rufuspollock]

@nyejon excellent question and we should document this. The best i can do right now is to point to the source. Here's the default config listing:

https://github.com/datopian/portaljs/blob/main/packages/core/src/config/default.ts

{
  title: "Flowershow",
  description: "",
  showEditLink: false,
  showToc: true,
  showSidebar: false,
  showLinkPreviews: true,
  author: "",
  authorLogo: "",
  domain: "",
  // Google analytics key e.g. G-XXXX
  analytics: "",
  // content source directory for markdown files
  // DO NOT CHANGE THIS VALUE
  // if you have your notes in another (external) directory,
  // /content dir should be a symlink to that directory
  content: "content",
  avatarPlaceholder: "/_flowershow/avatarplaceholder.png",
  contentExclude: [],
  contentInclude: [],
  blogDir: "blog",
  peopleDir: "people",
  // Theme
  theme: {
    default: "dark",
    toggleIcon: "/_flowershow/theme-button.svg",
  },
  navLinks: [
    // { href: '/about', name: 'About' },
  ],
}

[th1zan]

@rufuspollock is this list exhaustive ? Is there a way to change the default ToC's title "On this page" ? Thank you !

[rufuspollock]

@th1zan excellent question. No this isn't exhaustive as it is just the defaults. e.g. seo stuff https://flowershow.app/docs/seo is not there b/c it is just something you add. We would like to create a better list - chime in on this issue if you are interested #562

Is there a way to change the default ToC's title "On this page" ?

Not at the moment. If you'd like this please open an issue explaining what you'd like.

[dctanugi]

How is the proper syntax for contentExclude? Suppose for example that I wanted to only include pages tagged #work, and exclude all posts tagged #private, how I would do that?

I don't suppose there is a way to prevent uploading those files with the FlowerKit plugin for Obsidian in the first place, is there?

[mohamedsalem401]

You're likely referring to tags embedded within the file itself, for example:

tag: #private

In that case, contentExclude wouldn't be the appropriate solution.

[dctanugi]

You're likely referring to tags embedded within the file itself

Yes, that's correct. Is there a better solution for including/excluding tags?