build files in git and Github Pages about codedoc HOT 7 CLOSED

while you do need to have the html files on GitHub somehow (either on the master branch or on the gh-pages branch), you definitely DO NOT NEED the node_modules to be there. This is the repo for the documentation for codedoc, built using codedoc itself, and this is another example built using codedoc and hosted on GitHub pages, both on master branch, none having node_modules (or .codedoc/node_modules) on the repo.

that said, using GitHub Actions to not have the html files directly on the master branch itself is a pretty nice idea. I have been meaning to get around to it but couldn't find the time (I mean codedoc itself is just released less than a week ago), so kudos for the nice solution! I'll modify the issue title to properly reflect that (from node_modules in git and GitHub Pages to build files in git and GitHub Pages).

P.S. you don't need the cd .codedoc && npm install line. You can simply install codedoc cli beforehand and run codedoc update or codedoc u.

from codedoc.

added this section to official docs as well for how to achieve this. again, @LukasForst thanks for the neat solution!

from codedoc.

this solution resolves the issue. keeping it open until it is also added to the official documentation.

from codedoc.

Agggr, you're right about node_modules, my bad, I'm not frontend dev, sorry!

About the - cd .codedoc && npm install, I think that, in this case, the version of all libraries including codedoc remains same as during the local development thanks to the package-lock.json. Whereas using codedoc update can result in updating the libraries, no? If this is the case, I would propose to stick with npm install as if the pipeline would update libraries, it can potentially change some behavior or break something. However, if the commands are equal in terms of updating libraries, it is probably better to use codedoc update. (again, not frontend developer, so not sure whether I got this right)

from codedoc.

thats a good point, so lets keep it as is. since that affects people collaborating on some documentation together as well, I think for convenience I'll add an install command to CLI as well, which will just install packages instead of updating everything.

from codedoc.

it turns out there was a race condition for creating the assets folder which sometimes caused some assets not to be created during the build process. should be fixed by this, deployed via @codedoc/[email protected]

from codedoc.

Thanks! One last thing, you misspelled my name 😄, no biggie though

proposed by Lukas Frost, is to put all

should be

proposed by Lukas Forst, is to put all

from codedoc.