goessner / microjam

A minimalistic Jamstack approach for creating GitHub-Pages hosted sites.
https://goessner.github.io/microjam/
MIT License
44 stars 5 forks source link

Allow other base directories than "docs" #1

Closed klawr closed 4 years ago

klawr commented 4 years ago

GitHub Pages allows for 3 different sources in the repository.

If i am not mistaken microjam assumes that we want to operate entirely in /docs:

https://github.com/goessner/microjam/blob/94e1cd060b5a36e4970348e2475ac413e9d17ea9/extension.js#L96-L106

As the property of microjam in the package.json is mandatory anyway, the respective behavior could be given as e.g:

{
    "name": "first",
    "description": "My first web page using microjam",
    "version": "0.1.0",
    "author": "it's me",
    "microjam": {
         "dist": "docs"
     }
}

Whereas src could be any path, given the user more freedom to decide which style of GitHub Pages he/she wants to use, if at all.

goessner commented 4 years ago

... in fact I was thinking about exactly that (gh-pages branch seems to be outdated)

But I decided to start quite restrictive, as each level of freedom for the user adds another level of complexity and is one more source of bugs.

So wait and see how intense the user pressure is.

Thanks

goessner commented 4 years ago

Closing due to inactivity.