bitovi / bitovi/documentjs

Building from another branch/repo shouldn't require documentjs.json in both branches

Open
#153 1 comment 0 reactions 0 assignees View on GitHub
configuration usability
Dominant language
JavaScript
Stars
598
Forks
371
PR merge metrics
No merged PRs in 30d

Description

While trying to build in a separate branch (gh-pages) from master, if the master doesn't already have a documentjs.json file, DocumentJS seems to try to crawl and create documentation out of everything, which almost always results in an error and aborted build. (like its doing a glob of `**/*.{js,md}` All I wanted to do in this case was to build the README.md file from master into the html templates in gh-pages. I don't want to put my templates in master in order to keep my master branch clean, so really the master branch doesn't need to contain a documentjs.json config file.

Here's my documentjs.json from gh-pages:

``` json
{
"versions": {
"0.0.1": "git://github.com/marshallswain/amityapp#master"
},
"defaultVersion": "0.0.1",
"siteDefaults": {
"static":"theme/static",
"templates": "theme/templates"
},
"sites": {
"pages": {
"glob": "amityapp/README.md",
"dest": "."
}
}
}
```

If I put an empty documentjs.json file into master, it works as expected from the config in gh-pages.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.