Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace Wyam documentation with Statiq #8

Open
AdmiringWorm opened this issue Sep 1, 2020 · 5 comments
Open

Replace Wyam documentation with Statiq #8

AdmiringWorm opened this issue Sep 1, 2020 · 5 comments

Comments

@AdmiringWorm
Copy link
Member

AdmiringWorm commented Sep 1, 2020

Wyam documentation was recently added, but the long term goal will be to replace the documentation generated by Wyam with Statiq.

This is probably something I would need help with to achieve

@gep13
Copy link

gep13 commented Sep 1, 2020

This is something I would like to get into Cake.Recipe as well, assuming this makes sense.

@AdmiringWorm
Copy link
Member Author

I think it would make sense to get that into Cake.Recipe at some point as well.
Not sure how that would work though, as Statiq seems a bit more modular (maybe not the right word), and relies more on what the user has configured rather than having specific arguments like the wyam executable have.

@gep13
Copy link

gep13 commented Sep 2, 2020

This is the thing that I am not sure about, and haven't dug into. I think the idea is that there is going to be pre-baked packages that will mean Statiq can be used in the same way that Wyam is today, but would need to check with @daveaglick to confirm.

@daveaglick
Copy link

I haven't totally decided whether Statiq Web and Statiq Docs will ship global tools (it doesn't make sense to ship one for Statiq Framework since that's more of a framework than anything with in-the-box functionality). Either way, we should be able to get an integration going. If a global tool ships then it can be called by forking a process like Wyam is now. If not, then it would be fairly easy for the Cake script to "embed" Statiq Docs and run it in-process. I've also got an idea in the back of my mind that we could make a Statiq-Cake bridge so that when running Statiq from Cake you could pass in the current Cake environment and Statiq would use it.

Anyway, that's all down the road. The more immediate goal is to start work on Statiq Docs (the equivalent of the Wyam docs recipe). Hoping to get that underway any day now.

@gep13
Copy link

gep13 commented Sep 2, 2020

@daveaglick all of this sound great! Looking forward to checking it out when the pieces are ready. This is definitely something that we will want to get into Cake.Recipe once it is ready.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants