https://github.com/thatopen/info
https://github.com/thatopen/info
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thatopen/info
- Owner: ThatOpen
- Created: 2024-01-09T14:12:46.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T14:22:00.000Z (about 2 years ago)
- Last Synced: 2025-05-03T08:27:39.765Z (11 months ago)
- Language: JavaScript
- Size: 9.06 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
THIS DOCS ARE FROM DEPRECATED LIBRARIES. THEY WON'T BE UPDATED ANYMORE. CHECK COMPONENTS INSTEAD
IFC.js docs
This repository was the official documentation of [IFC.js](https://github.com/IFCjs) until september 20, 2023. It contains all the information regarding the project at that time, including:
- The motivation behind IFC.js.
- Introduction to all the modules of the library.
- API reference.
- Step by step tutorials.
- Informal articles of the authors.
## Status
This documentation is deprecated.
## Quick setup
First, download this project or clone the repository and install the dependencies with `yarn install`. You can then start the project locally using `yarn start`.
To start the project in another lanaguage, you can use the `--locale` flag:
- japanese: `yarn start --locale ja`
- chinese: `yarn start --locale zh`
## Content
This project consists of the following folders:
- **docs**: the markdown documents of the documentation.
- **blog**: the markdown documents of the blog.
- **i18n**: the markdown documents of the docs in other languages.
- **src**: react components used in the docs to make cool stuff.
- **static**: images and icons.