Bug with defaultDest
- Dominant language
- JavaScript
- Stars
- 598
- Forks
- 371
- PR merge metrics
- No merged PRs in 30d
Description
"home" override in the docConfig
To make publishing setup easier (when a separate home page isn't wanted), it would be nice to have a "home" config option to specify a site from the master branch's documentjs.json that we want to be promoted to the home page. This would basically override it to publish to `"dest" : "."` The example configs below would publish the "docs" site into the root folder of the gh-pages branch.
In master:
``` json
{
"sites": {
"docs": {
"parent": "DocumentJS",
"pageConfig": {"page":"docs"},
"glob": {
"pattern": "{docs,tags,lib,tasks}/**/*.{js,md}",
"ignore": "lib/{configured,process,generate,find,generators/html}/test/**/*"
}
}
}
}
```
In gh-pages:
`````` json
{
"versions": {
"1.0": "git://github.com/marshallswain/can-stache-moment#master"
},
"defaultVersion": "1.0",
"home":"docs"
}```
``````
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by tracing how documentjs.json handles site destinations and defaultDest across the master and gh-pages configurations shown in the issue. Confirm that a home value such as "docs" promotes that site to the root destination, then verify publishing with the example configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100