https://github.com/flowsynx/docs
Website for the GenoFlow project
https://github.com/flowsynx/docs
documentation docusaurus flowsynx
Last synced: 4 months ago
JSON representation
Website for the GenoFlow project
- Host: GitHub
- URL: https://github.com/flowsynx/docs
- Owner: flowsynx
- License: mit
- Created: 2023-12-13T22:19:54.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2026-02-15T21:50:05.000Z (4 months ago)
- Last Synced: 2026-02-16T04:34:38.814Z (4 months ago)
- Topics: documentation, docusaurus, flowsynx
- Language: MDX
- Homepage: https://flowsynx.io
- Size: 17.9 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FlowSynx documentation and blog
[![License: MIT][mit-badge]][mit-url]
[mit-badge]: https://img.shields.io/github/license/flowsynx/docs?style=flat&label=License&logo=github
[mit-url]: https://github.com/flowsynx/docs/blob/master/LICENSE
If you are looking to explore the FlowSynx documentation, please go to the documentation website:
https://flowsynx.io
This repo contains the markdown files which generate the above website. See below for guidance on running with a local environment to contribute to the docs.
## Overview
The FlowSynx docs and blog are built using **Docusaurus**, hosted on an Github page.
The flowsynx docs directory contains the docusaurus project, markdown files, and theme configurations.
## Setup on local machine
### Pre-requisites
* Node.js
### Environment setup
1. Ensure pre-requisites are installed.
2. [Fork](https://github.com/flowsynx/docs/fork) and clone this repository.
3. Go to the cloned repository directory.
4. Open the forked repository in VS Code
```
code .
```
5. Install npm packages:
```
npm install --global docusaurus-init
```
```
npm install
```
## Running the development server
1. Make sure you're in the root directory.
2. Run
```
npm run start
```
By default, a browser window will open at http://localhost:3000.