Skip to content

sven-coop/sven-coop.github.io

Repository files navigation

Sven Co-op Documentation Generator

https://sven-coop.github.io/

Community additions can be proposed in the additions.yaml file following the same hierarchy as outputdocs.yaml

TODO

  • Advanced Search
  • 'Inherited from'

Building

When Sven Co-op updates to a new version, the AngelScript API will change. To build your own documentation if this repository becomes outdated:

  • Run Sven Co-op with the launch command: -as_outputdocs outputdocs
  • This will create a file at ...\Sven Co-op\svencoop\outputdocs.txt
  • Move the newly generated outputdocs.txt into a clone of this repo.
  • Update or install Node.js.
  • In terminal, set your working directory to the cloned repo.
  • Type npm install to install the dependencies.
  • Type npm run build to generate the site into a dist folder.