Docz: Read name from package.json and populate title by default

Created on 14 Jun 2018  路  5Comments  路  Source: doczjs/docz

Feature Request

It would be nice if the "MyDoc" title defaulted to the name property inside package.json

Describe the solution you'd like

Read package.json name and populate title

Describe alternatives you've considered

Maybe creating a theme that does this? 馃

Teachability, Documentation, Adoption, Migration Strategy

the config file and other ways to set the title should overwrite this, reading name from package.json should probably only be done if there's no title configured. This would make it more zero-config than it is right now.

Most helpful comment

Maybe we could send the whole package.json to the theme in some way, maybe a helper to fetch it in some way. If we could do that themes could use data from package.json to display version, name (with or without humanise), pick up repository to automatically link to GitHub etc

All 5 comments

Good point @albinekb, I'm thinking about that, but we would need to humanize the app name from package.json and not sure it is a good choice 馃

maybe an "camelcasefy" on package name @pedronauck ?

Maybe we could send the whole package.json to the theme in some way, maybe a helper to fetch it in some way. If we could do that themes could use data from package.json to display version, name (with or without humanise), pick up repository to automatically link to GitHub etc

To facilitate user feedbacks and make a really good roadmap, now we're using Canny as a tool to create our roadmap 馃槏

We think that is better keep Github issues only for bugs and other issues! 馃悶
This issue is already on our roadmap, so I'll close this issue in favor of it!

馃憠馃徎 Check this issue on roadmap

Released in the new v0.5.0 馃殌

Was this page helpful?
0 / 5 - 0 ratings

Related issues

mariusespejo picture mariusespejo  路  3Comments

regrettably picture regrettably  路  3Comments

wldcordeiro picture wldcordeiro  路  3Comments

albinekb picture albinekb  路  3Comments

nicholasess picture nicholasess  路  3Comments