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

[Packages] Add docs for the state populated by the Frontity core package #1

Open
DAreRodz opened this issue Feb 4, 2021 · 1 comment

Comments

@DAreRodz
Copy link
Member

DAreRodz commented Feb 4, 2021

In the same fashion other packages do (e.g. @frontity/wp-source), the frontity package also exposes state that other packages may use.

The state properties and their description can be found in this file of the frontity monorepo: /packages/types/src/frontity.ts

@juanmaguitar
Copy link
Member

@DAreRodz

When you say

the frontity package also exposes state that other packages may use.

Do you mean @frontity/core package, right?

And, are you referring specifically to document these properties that can be seen under state.frontity?

"{
  "url": "https://twentytwenty.frontity.org",
  "title": "Test Frontity Blog",
  "description": "Useful content for Frontity development",
  "name": "twentytwenty-theme",
  "mode": "default",
  "debug": false,
  "platform": "client",
  "rendering": "csr",
  "initialLink": "/",
  "options": {},
  "packages": [
    "@frontity/tiny-router",
    "@frontity/html2react",
    "@frontity/twentytwenty-theme",
    "@frontity/wp-source"
  ]
}"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants