An open API service indexing awesome lists of open source software.

https://github.com/scifracx/scifracx.github.io

SciFracX official website
https://github.com/scifracx/scifracx.github.io

documentation website

Last synced: 18 days ago
JSON representation

SciFracX official website

Awesome Lists containing this project

README

          

# SciFracX Website

SciFracX website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. Inspired by [QuantumOptics.jl](https://qojulia.org/) website.

### Installation

1. ```git clone https://github.com/SciFracX/scifracx.github.io``` to download the website source code.
2. ```cd scifracx.github.io``` to enter the website source code directory.
3. ```yarn``` to install dependencies.

### Run locally

```
$ yarn start
```

And you can visit the website at http://localhost:3000.

### Publish

Whenever a new commit lands in master, the change will be automatically published to the **gh-page** branch and then published to the website: https://scifracx.org.

## Contributing

If you're here because you would like to contribute an edit or addition to the docs, you'll probably want to take a look at the docs/ directory.

To edit the internals of how the site is built, you may want to get familiarized with how the site is built. The Casdoor website is a static site generated using Docusaurus. This directory is the frame of casdoor website. Visit the [Docusaurus website](https://docusaurus.io) to learn more about all the available configuration options.