info
info copied to clipboard
Official documentation for IFC.js.
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 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.