Hello @daveaglick . Want to start new documentation project(s) to host at Github Pages (/docs folder) and looking at Wyam. Understand that Statiq is the successor. Should I wait for Statiq releases and if so, how long is the expected wait. Or Should I go ahead and use Wyam - in that case will it be portable to Statiq and is it still supported. Kindly advise - Thanks.
@absinghal 👋 - Wyam works just fine and still powers docs for projects like Cake. That said, you're correct that Statiq is on the horizon and I'm not investing additional effort in also adding functionality to Wyam (thay're essentially the same project, just gone through a rebrand for the next version). Statiq Docs will be mostly compatible with the Wyam docs recipe, though not entirely run and forget - there will likely be a little required porting for things like settings (and more depending on how heavily the Wyam site was customized). The bigger issue for API docs is that I'm still a few months from working on Statiq Docs. If you don't need to generate actual API docs from source files or assemblies though and just need content-oriented docs, Statiq Web is very close (there's actually alphas already on NuGet) and I expect that to be usable within the next couple weeks.
Also for one github repo, I’d like to have docs.projectname.com/blog layout for blog and docs.projectname.com/help for documentation. Is it possible thru Github pages from the same /docs folder of the repo?
I have more or less taken over the project from Ivan Balan and there are features people are requesting that I don't need and am not sure as to the best path forward.
My thought is we might be able to help each other.
I want to reboot the docs for FluentMigrator and make them prettier
I keep 🤞 that GitHub turns on discussions as a wider beta soon - if you haven’t seen it, check out https://github.com/zeit/now/discussions
When that’s available I’ll probably shut this down and move all conversation there
is Statiq ready for prime time?
Whereas Wyam had a single core application and different “recipes”, Statiq has Statiq Framework and Statiq Web/Statiq Docs.
Statiq Framework just went Beta. That means I think it’s relatively stable, most obvious bugs are caught, and I’ll limit (or at least keep in mind) API breaks. Several other folks are using it production today (including me at my day job). I’d say it’s ready for prime time.
Statiq Web is being actively worked on and can be used but has a ways to go and Statiq Docs will likely start work soon.
@jzabroski ^^^ forgot to tag you in any of those, and Gitter notifications can be pretty flaky
I kind of feel bad since Im not a Razor expert - I use it to generate email templates for an Issue Tracker system similar to Jira
i've tried doing
Settings[Keys.LinkRoot] = "/api";
Settings[DocsKeys.ApiPath] = "/";
but that causes nothing to be generated for the api
is there a way to just generate the API part?
and have
/index.html be the namespace listing that would usually appear at /api?
I've managed to set up Wyam - bit confued about setting content directories. By default Wyam will create a Content directory for me (input) but if I want to rename that I have to pass -i <new folder name> to wyam when building. Can I put that in the config.wyam file?
someone already had this problem?
Does anyone here have experience creating a GraphQL input module for Statiq? I found a great blog post here but no code: https://orcharddojo.net/blog/this-week-in-orchard-10-18-2019
Just an example of a non-trivial module would be good enough for now :)
Just an example of a non-trivial module would be good enough for now :)
@slang25 I've heard some talk of folks working on GraphQL modules but haven't seen one "in the wild" yet. That said, data modules are generally pretty straight-forward - you fetch some data and create documents from it. A good similar example might be this SQL module: https://github.com/statiqdev/Statiq.Framework/blob/cdf6048822e3af54506be1d4f3e5fb5af5e25962/src/core/Statiq.Core/Modules/Metadata/ReadSql.cs - you could even consider deriving from the
ReadDataModule (https://github.com/statiqdev/Statiq.Framework/blob/master/src/core/Statiq.Common/Modules/ReadDataModule.cs) if you can get the data from GraphQL into a dictionary
@daniloalsilva I haven't heard any reports of trouble with tables in alternate platforms - there was/is an issue with
_ViewStart.cshtml vs. _viewstart.cshtml (the latter doesn't work on Linux), but that's a casing thing (the Razor engine is case-specific) - are you still having trouble with it? If so, go ahead and file a GitHub issue and we can start taking a closer look
@computa_mike_twitter Yes, you can change the input folders from the config file - you can add new ones or even change the "input" one to something different. The trick is that the config script has a global
Engine property you can use which exposes a FileSystem property (which is of type IFileSystem - https://wyam.io/api/wyam.common.io/ifilesystem/). So the script should contain something like Engine.FileSystem.InputPaths.Add("other").
is there an include that uses xrefs?
@StevenTCramer
is there an include that uses xrefs?
No but that's a great idea: statiqdev/Statiq.Web#908
The existing shortcodes are a big missing part of the docs - the Web specific ones are documented at https://statiq.dev/web/content-and-data/content/shortcodes but I need to do the same for the ones coming from Framework like
Include
Gatsby look out Statiq is in the house.
@/all 🚨 Major announcement time! Statiq has been accepted into the GitHub Discussions early access program! Effective immediately all discussion should move to https://github.com/statiqdev/Discussions/discussions - I won't be monitoring the Gitter channel any longer. I'm excited to see if we can continue to grow the awesome Wyam/Statiq community in a more transparent way through the discussions platform. 🚨
