https://github.com/design-first/system-runtime-documentation
System Runtime Documentation
https://github.com/design-first/system-runtime-documentation
Last synced: 6 months ago
JSON representation
System Runtime Documentation
- Host: GitHub
- URL: https://github.com/design-first/system-runtime-documentation
- Owner: design-first
- License: mit
- Created: 2018-07-17T14:47:24.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-01-13T17:17:13.000Z (over 2 years ago)
- Last Synced: 2024-01-14T02:48:09.295Z (over 2 years ago)
- Language: JavaScript
- Homepage: https://designfirst.io/systemruntime/documentation/
- Size: 1.27 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# System Runtime Documentation
This repository contains the documentation of [System Runtime](https://github.com/design-first/system-runtime) that is available [online](https://designfirst.io/systemruntime/documentation/).
You can use this project to read the documentation locally.
## Installation
Clone the repository:
```sh
git clone https://github.com/design-first/system-runtime-documentation.git
```
Install the dependencies:
```sh
cd website
npm i
```
## Build the documentation
```sh
npm run build
```
Then go to `build` folder and open `index.html` in your browser to read the documentation.
## Development
- Rename `siteConfig.website.js` to `siteConfig.js`.
- Start the server:
```sh
npm run start
```
- A browser will open the documentation site. If not, go to `http://localhost:3000`.
- Update the documentation in `docs` folder.
> Note: the page is automatically refreshed when you modify the documentation.
## Licenses
### Docusaurus
The MIT License (MIT)
Copyright (c) 2017-present, Facebook, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
### System Runtime
Copyright © 2026 Erwan Carriou
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
**Do not use System Runtime if you do not believe in Equality and Diversity.**
**System Runtime is not for people of hate.**