2024-06-04 12:03:43 +00:00
|
|
|
<h1> INCA Docs </h1>
|
2024-06-04 11:58:48 +00:00
|
|
|
|
2024-06-04 12:03:43 +00:00
|
|
|
<h2>Table of Contents</h2>
|
|
|
|
|
|
|
|
|
|
- [Introduction](#introduction)
|
|
|
|
|
- [Prerequisites](#prerequisites)
|
|
|
|
|
- [Website Preview](#website-preview)
|
|
|
|
|
- [License](#license)
|
|
|
|
|
- [References](#references)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Introduction
|
|
|
|
|
|
|
|
|
|
This repository contains the code to deploy the INCA Docs website, a project by [ThreeFold](https://threefold.io).
|
|
|
|
|
|
|
|
|
|
## Prerequisites
|
|
|
|
|
|
|
|
|
|
You need [npm](https://www.npmjs.com/) to run this website.
|
|
|
|
|
|
|
|
|
|
- Install `npm`
|
|
|
|
|
```
|
|
|
|
|
sudo apt update
|
|
|
|
|
sudo apt install nodejs
|
|
|
|
|
npm -v
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Website Preview
|
|
|
|
|
|
|
|
|
|
You can preview the website with a few lines.
|
|
|
|
|
|
|
|
|
|
```
|
2024-06-04 12:05:42 +00:00
|
|
|
git clone https://git.ourworld.tf/tfgrid/www_projectinca
|
2024-06-04 12:03:43 +00:00
|
|
|
cd inca_docs
|
|
|
|
|
npm install
|
|
|
|
|
npm run dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
For more information, read the original [AstroWind docs](./website_docs/README.md).
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
**INCA Docs** is licensed under the Apache 2.0 license — see the [LICENSE](./LICENSE.md) file for details.
|
|
|
|
|
|
|
|
|
|
## References
|
|
|
|
|
|
|
|
|
|
This INCA Docs website is based on the amazing [AstroWind repo](https://github.com/onwidget/astrowind).
|
|
|
|
|
|
|
|
|
|
We changed the license from MIT to Apache 2.0 to suit this specific project.
|
