https://github.com/intermine/intermine-user-docs
Documentation for using an InterMine webapp.
https://github.com/intermine/intermine-user-docs
Last synced: 8 months ago
JSON representation
Documentation for using an InterMine webapp.
- Host: GitHub
- URL: https://github.com/intermine/intermine-user-docs
- Owner: intermine
- License: lgpl-3.0
- Created: 2014-03-26T11:37:49.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T04:15:05.000Z (almost 3 years ago)
- Last Synced: 2024-04-09T21:05:56.448Z (almost 2 years ago)
- Language: JavaScript
- Size: 59 MB
- Stars: 3
- Watchers: 9
- Forks: 8
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# InterMine User Documentation
Documentation for using an InterMine webapp.
### Note on relative links
GitHub Pages adds a trailing slash when it sees the path is to a directory in the filesystem ([more info](https://stackoverflow.com/questions/33270605/github-pages-trailing-slashes)). This will cause relative links to have their origin nested by an additional level, causing them to lead to nonexistent paths. To avoid this, you should **always use absolute links** in the documentation.
# Docusaurus 2
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Installation
```console
yarn install
```
## Local Development
```console
yarn start
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
## Build
```console
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## 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/intermine-user-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
```