search

spanezz / staticsite

Static site generator
GNU General Public License v3.0
46 stars 7 forks source link

GitHub/repository mode? #4

Closed TobiX closed 7 years ago

TobiX commented 7 years ago

I wonder if you would be interested in a "GitHub mode".

Usecase: When publishing a software project on GitHub, the README.md is the main entry point into the documentation, maybe linking other markdown documents in the repository. It should be easy to turn this structure into a nice homepage for the project (and push it to the gh-pages branch).

Modification needed:

If you think something like this sounds useful, I'll start working on it...

spanezz commented 7 years ago

By all means, go ahead! I think it would be really useful, for publishing to static pages, for building documentation for offline reading, or for live preview (ssite serve) while editing documentation.

TobiX commented 7 years ago

Seems GItHub beat me to it: https://github.com/blog/2289-publishing-with-github-pages-now-as-easy-as-1-2-3 - I'll probably still finish my changes when I get around to it...

spanezz commented 7 years ago

I've merged the pull request and I'm closing the issue. I guess somewhere it should be advertised that staticsite can now be used as live preview for gitub repo documentation, though I'm not good at advertising :/ Can you give me a link to a github repo that has pages in it, that I could use as an example?