https://github.com/akayeshmantha/openmrs-docs
https://github.com/akayeshmantha/openmrs-docs
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/akayeshmantha/openmrs-docs
- Owner: Akayeshmantha
- License: other
- Created: 2019-09-17T08:42:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-20T02:11:47.000Z (over 2 years ago)
- Last Synced: 2025-02-01T22:12:57.646Z (4 months ago)
- Language: JavaScript
- Size: 266 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# OpenMRS REST API documentation
OpenMRS documentation is built using [Slate](https://github.com/tripit/slate).
# Getting Started with Slate
### Prerequisites
You're going to need:
- **Linux or macOS** — Windows may work, but is unsupported.
- **Ruby, version 2.3.1 or newer**
- **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal.
### Getting Set Up
1. Fork this repository on GitHub.
2. Clone *your forked repository* (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/OpenMRS-docs.git`
3. `cd OpenMRS-docs`
4. Initialize and start OpenMRS-docs. You can either do this locally, or with Vagrant:
```shell
# either run this to run locally
bundle install
bundle exec middleman server
# OR run this to run with vagrant
vagrant up
```
## Editing documentation content
All documentation is in `includes` directory, and uses Markdown text format,
plus some Slate widgets (such as notices).