BRMW documentation

docs.brmodeloweb.com

This repository holds the oficial usage documentation of BRMW a open source web based tool to create database modeling.

Contribution

You're more than welcome to contribute to this docs by fixing erros, adding content or translations. Please take a look in the contribution guidelines (Contribution guidelines still pending) before submit your pull request.

Dependencies

• EditorConfig
• Node.js (Strongly recommended to install it via nvm or n)
• Yarn

Running application

This documentation is built with VitePress. The markdown content lives in the docs/ folder.

1. Install dependencies: yarn install
2. Start the dev server: yarn start (alias for yarn docs:dev)
3. Build for production: yarn docs:build (output in docs/.vitepress/dist)
4. Preview the production build: yarn docs:preview

Deployment

The site is deployed to GitHub Pages by the deploy-docs GitHub Actions workflow on every push to main.