search

VeryGoodOpenSource / very_good_docs_site

A Very Good Documentation Site created by the Very Good Ventures Team 🦄
https://brickhub.dev/bricks/very_good_docs_site
MIT License
15 stars 1 forks source link

build: Unclear how to build and serve non-default docs #118

Closed leaf-node closed 7 months ago

leaf-node commented 1 year ago

Description

When I try to build and serve the docs locally, I just get a demo site.

podman run -it --net host --mount=type=bind,source=very_good_docs_site/,destination=/srv node /bin/bash
cd /srv/src/very_good_docs_site/
npm install
npm run build
npm run serve
npm start

Requirements

The compiled site should show up. Maybe I'm doing this wrong. Thanks for your help.

renancaraujo commented 11 months ago

Hello @leaf-node , what steps did you follow to generate your project?

You can use as a standalone brick: https://brickhub.dev/bricks/very_good_docs_site#usage Or via Very good CLI: https://cli.vgv.dev/docs/templates/docs_site

leaf-node commented 11 months ago

I only tried the method in my original post, which was basically running npm commands from the repo readme file, but wrapped in a podman container. I haven't tried the other approaches at this time, but if they work, it would be helpful to document them in the main readme file. Thanks! :smile:

alestiago commented 7 months ago

We're moving this repository to Very Good Templates. Hence, I'm closing this issue. I'll reopen it there once I verify that the documentation is still needed.