Docusaurus: tagline and favicon should not be required fields

Created on 12 Nov 2019  路  4Comments  路  Source: facebook/docusaurus

馃挜 Proposal

Consider making https://v2.docusaurus.io/docs/docusaurus.config.js#tagline and https://v2.docusaurus.io/docs/docusaurus.config.js#favicon as part of themeConfig and not as required fields

In v1, it has to be required field because a lot of the React components need it and all the UI is locked-in. This is no longer the case in v2, i think its very coupled to theme-classic and this can make the config smaller.

P.S this is breaking change but should be fine ??? Thoughts ?

Have you read the Contributing Guidelines on issues?

yes

good first issue proposal v2

Most helpful comment

@endiliey I would make favicon a required field, and tagline - optional, but not both of them.

All 4 comments

Can I work on this issue?

what do you think of this @yangshun @wgao19 @lex111 ? before we move forward

@endiliey I would make favicon a required field, and tagline - optional, but not both of them.

im not sure about favicon, but i agree tagline should be optional.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

sebqq picture sebqq  路  3Comments

chandankumar4 picture chandankumar4  路  3Comments

NikitaIT picture NikitaIT  路  3Comments

endiliey picture endiliey  路  3Comments

awibox picture awibox  路  3Comments