View rendered docs locally about docs-ts HOT 4 OPEN

I'm about to create a PR with a docker file. I think that really makes sense. There will be some instructions in the readme, too.

When I have something up and running, we can discuss the details. stay tuned.

from docs-ts.

While I think this is potentially useful, I think it is outside the scope of the library.

I think the biggest issue for me here is the work that is required on behalf of the library user to get this up and running. If we could figure out a more user-friendly way to allow users to visualize their documentation (maybe via a Docker image that we bundle with the lib or something), then I would be all for this.

from docs-ts.

We could add the instructions to the docs on how to run locally with Jekyll.

However, if we include something I'd rather go the Dockerfile way as well.

from docs-ts.

That is very true - I do think this could be super useful to someone trying to figure out what the rendered docs would look like, especially with other themes.

@thought2 - maybe you could open a PR to add the instructions for doing this to the FAQ section in the README?

from docs-ts.