https://github.com/intermine/im-docs
Documentation for the InterMine project
https://github.com/intermine/im-docs
Last synced: 5 months ago
JSON representation
Documentation for the InterMine project
- Host: GitHub
- URL: https://github.com/intermine/im-docs
- Owner: intermine
- License: mit
- Created: 2012-11-08T15:56:28.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T23:43:36.000Z (almost 3 years ago)
- Last Synced: 2025-04-02T06:51:10.621Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 102 MB
- Stars: 5
- Watchers: 12
- Forks: 28
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: docs/support/mailing-list.md
Awesome Lists containing this project
README
# InterMine Server Documentation
Documentation for the [InterMine](http://intermine.org) project.
## Documentation
The HTML documentation is generated from Markdown docs, using the static site generator called [Docusaurus](https://v2.docusaurus.io/).
## Building locally
You should build locally before you push, to make sure your changes are correct. You will need **nodejs** (version >= 10.15.1) and **yarn** (version >= 1.5) installed.
Building the docs:
```bash
cd im-docs
yarn install
yarn start
```
## Deployment
This repository uses GitHub Actions to automatically deploy any changes pushed to the master branch to GitHub Pages. The website is deployed to: http://intermine.org/im-docs/
If you wish to deploy manually for some reason, you can use the below command considering you have commit access to the repository.
```console
GIT_USER= USE_SSH=true yarn deploy
```