Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/interlay/interlay.github.io
Interlay documentation for users, vaults, developers and everyone else.
https://github.com/interlay/interlay.github.io
bitcoin bridge docsify documentation interbtc kbtc kintsugi polkadot
Last synced: 2 days ago
JSON representation
Interlay documentation for users, vaults, developers and everyone else.
- Host: GitHub
- URL: https://github.com/interlay/interlay.github.io
- Owner: interlay
- License: apache-2.0
- Created: 2021-01-21T13:32:06.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-20T18:44:12.000Z (9 months ago)
- Last Synced: 2024-02-20T19:50:33.252Z (9 months ago)
- Topics: bitcoin, bridge, docsify, documentation, interbtc, kbtc, kintsugi, polkadot
- Language: Shell
- Homepage: https://docs.interlay.io/#/
- Size: 32.7 MB
- Stars: 7
- Watchers: 3
- Forks: 30
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Interlay Documentation
Interlay documentation for users, vaults, developers and anyone else.
## About
This is the central place for user guides and links to developer documentation in the IBTC universe.
## Getting Started
### Prerequisites
Make sure you have `yarn` installed. Install docsify globally:
```shell
yarn global add docsify-cli
```
### Installation
Clone the repository:
```shell
git clone [email protected]:interlay/interbtc-docs.git
```
Build the documentation:
```shell
docsify serve ./docs
```
## Usage
You can browse the documentation locally or directly on [docs.interlay.io](https://docs.interlay.io).
### Adding content
All pages are written using [docsify](https://docsify.js.org). Follow their guide to add new pages: [https://docsify.js.org/#/more-pages](https://docsify.js.org/#/more-pages)
### Themes
The theme is based on [docsify-themable](https://jhildenbiddle.github.io/docsify-themeable/) and is very simple to customize: [https://jhildenbiddle.github.io/docsify-themeable/#/customization](https://jhildenbiddle.github.io/docsify-themeable/#/customization)
## Contributions
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
1. Fork the Project
2. Clone your new fork and enter the working folder (`git clone https://github.com/youruser/interlay.github.io.git && cd interlay.github.io`)
3. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
4. Make your changes
5. Commit your changes (`git commit -m 'feat: Add some AmazingFeature'`)
6. Push to the branch (`git push origin feature/AmazingFeature`)
7. Open a Pull Request
We are using [semantic versioning](https://semver.org/) and [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#summary).
If you are searching for a place to start or would like to discuss features, reach out to us:
- [Telegram](https://t.me/interlay)
- [Discord](https://discord.gg/interlay)