/docs-prototype-docsify

Primary LanguageHTML

DragonRuby Docs

This is the public repository of the DragonRuby documentation. The documentation is built using Docsify.

You can find the latest version of the documentation at https://dragonruby-docs.github.io/. This repository is only needed if you want to contribute to the documentation.

Install and run locally

  1. Install nodejs and npm (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
  2. Run npm install in the root directory of this repo
  3. Run npm run docs to start the local server

How to contribute

  1. Fork this repository under your own account
  2. Make your changes into a new branch
  3. Run the documentation locally to check your changes
  4. Create a pull request to this repository