https://github.com/interep-project/docs

InterRep documentation website.
https://github.com/interep-project/docs

Last synced: 9 days ago
JSON representation

InterRep documentation website.

• Host: GitHub
• URL: https://github.com/interep-project/docs
• Owner: interep-project
• License: mit
• Created: 2021-09-09T12:51:12.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T16:12:49.000Z (over 1 year ago)
• Last Synced: 2023-03-06T18:26:33.334Z (over 1 year ago)
• Language: CSS
• Homepage: https://docs.interep.link
• Size: 1.48 MB
• Stars: 5
• Watchers: 3
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE
  • Code of conduct: docs/code-of-conduct.md

Awesome Lists containing this project

README

        


    


        Interep docs

    

    
Interep documentation website.




    

        

    

    

        

    

    

        

    

    





    


        

            👥 Contributing

        

          |  

        

            🤝 Code of conduct

        

          |  

        

            🗣️ Chat & Support

        

    



Our [documentation website](https://docs.interep.link) was generated with [Docusaurus](https://docusaurus.io/). Please, check https://docusaurus.io/docs for more information.

___

## 🛠 Install

Clone this repository and install the dependencies:

```bash

git clone https://github.com/interep-project/docs.git

cd docs && yarn

```

## 📜 Usage

### Local Development

```

yarn start

```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```

yarn build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

```

GIT_USER= USE_SSH=true yarn deploy

```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

**Notice**: You can find all the markdown documentation files in the `docs` folder.