System Designer Documentation

This repository contains the documentation of System Designer that is available online. You can use this project to read the documentation locally.

Installation

Clone the repository:

git clone https://github.com/design-first/system-designer-documentation.git

Install the dependencies:

cd website
npm i

Build the documentation

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:

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 Designer

Copyright © 2024 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

https://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 Designer if you do not believe in Equality and Diversity.

System Designer is not for people of hate.