/docs

(WIP) Crucible Necronomicon, Docs & Knowledge

Primary LanguageJavaScriptMIT LicenseMIT

(WIP) Crucible Necronomicon, Docs & Knowledge

The place to hold everything about Crucible and bits of legacy minecraft modding.

This project uses Docusaurus for static website generation.

Contributing

Most contributions can be done without touching code, however you will need yarn to run a live test and see your changes. All documentation pages within ./docs folder are written in Docusaurus's Markdown flavour.

Docusaurus documentation may prove useful for working on this project.

Documentation writing style is yet to be decided, for now follow a style similar to the other pages.

Installation

$ yarn

This command will set up all the project dependencies and make it ready to use.

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

License

Necronomicon is MIT licensed.

The documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.