mirror of
https://gitlab.nic.cz/turris/reforis/foris-js.git
synced 2024-12-24 00:01:36 +01:00
Improve docs introduction section
This commit is contained in:
parent
83caf505d9
commit
68c560078b
4
docs/forisjs-npm.svg
Normal file
4
docs/forisjs-npm.svg
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="500" height="500" fill="white">
|
||||||
|
<path d="M49.5 171.722222222222h400v133.333333333333h-200v22.222222222223h-88.888888888889v-22.222222222223H49.5V171.722222222222zm22.222222222222 111.111111111111h44.444444444445v-66.666666666667h22.222222222222v66.666666666667h22.222222222222v-88.888888888889H71.722222222222v88.888888888889zm111.111111111111-88.888888888889v111.111111111111h44.444444444445v-22.222222222222h44.444444444444v-88.888888888889h-88.888888888889zm44.444444444445 22.222222222222H249.5v44.444444444445h-22.222222222222v-44.444444444445zm66.666666666666-22.222222222222v88.888888888889h44.444444444445v-66.666666666667h22.222222222222v66.666666666667h22.222222222222v-66.666666666667h22.222222222222v66.666666666667h22.222222222223v-88.888888888889H293.944444444444z" fill="#cb3837" />
|
||||||
|
<path d="M71.722222222222 282.833333333333h44.444444444444v-66.666666666667h22.222222222223v66.666666666667h22.222222222222v-88.888888888889H71.722222222222zm111.111111111111-88.888888888889v111.111111111111h44.444444444444v-22.222222222222h44.444444444445v-88.888888888889h-88.888888888889zM249.5 260.611111111111h-22.222222222223v-44.444444444445H249.5v44.444444444445zm44.444444444444-66.666666666667v88.888888888889h44.444444444444v-66.666666666667h22.222222222223v66.666666666667h22.222222222222v-66.666666666667h22.222222222222v66.666666666667h22.222222222222v-88.888888888889z" />
|
||||||
|
</svg>
|
After Width: | Height: | Size: 1.4 KiB |
|
@ -1,6 +0,0 @@
|
||||||
Foris JS library is set of components and utils for Foris JS application and
|
|
||||||
plugins.
|
|
||||||
|
|
||||||
Please notice that all of these components or utils are used in reForis and
|
|
||||||
plugins. If you like to study by example I would recommend to full-text search
|
|
||||||
these repos.
|
|
37
docs/introduction.md
Normal file
37
docs/introduction.md
Normal file
|
@ -0,0 +1,37 @@
|
||||||
|
Welcome! This is the official documentation for Foris JS.
|
||||||
|
|
||||||
|
## What Foris JS is
|
||||||
|
|
||||||
|
Foris JS library is a set of components and utils for reForis application and
|
||||||
|
plugins.
|
||||||
|
|
||||||
|
Please notice that all of these components or utils are used in reForis and
|
||||||
|
plugins. If you want to study them by example, I recommend you to full-text
|
||||||
|
search those repositories.
|
||||||
|
|
||||||
|
# Installation
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
Please make sure that [Node.js](https://nodejs.org/en/) is installed on your
|
||||||
|
system.
|
||||||
|
|
||||||
|
The current Long Term Support (LTS) release is an ideal starting point, see
|
||||||
|
[here](https://github.com/nodejs/Release#release-schedule).
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
To install the latest release:
|
||||||
|
|
||||||
|
```plain
|
||||||
|
npm install foris
|
||||||
|
```
|
||||||
|
|
||||||
|
To install a specific version:
|
||||||
|
|
||||||
|
```plain
|
||||||
|
npm install foris@version
|
||||||
|
```
|
||||||
|
|
||||||
|
<a target="_blank" href="https://www.npmjs.com/package/foris">Check
|
||||||
|
on<img width="100px" src="./docs/forisjs-npm.svg"></a>
|
|
@ -11,8 +11,8 @@ module.exports = {
|
||||||
title: "Foris JS docs",
|
title: "Foris JS docs",
|
||||||
sections: [
|
sections: [
|
||||||
{
|
{
|
||||||
name: "Foris JS",
|
name: "Introduction",
|
||||||
content: "docs/intro.md",
|
content: "docs/introduction.md",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "Development (Linking)",
|
name: "Development (Linking)",
|
||||||
|
|
Loading…
Reference in New Issue
Block a user