development_docs_inca_basic #100
3
docs_projectinca/Makefile
Normal file
3
docs_projectinca/Makefile
Normal file
@ -0,0 +1,3 @@
|
||||
run:
|
||||
npm install
|
||||
npm run dev
|
||||
@ -1,54 +1,103 @@
|
||||
# Starlight Starter Kit: Basics
|
||||
<h1> Project INCA Docs </h1>
|
||||
|
||||
[](https://starlight.astro.build)
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Install the prerequisites on Ubuntu](#install-the-prerequisites-on-ubuntu)
|
||||
- [Install the prerequisites on MAC or Linux with Brew](#install-the-prerequisites-on-mac-or-linux-with-brew)
|
||||
- [Check if the Prerequisites Are Installed](#check-if-the-prerequisites-are-installed)
|
||||
- [Clone the Repository](#clone-the-repository)
|
||||
- [Preview the Website](#preview-the-website)
|
||||
- [License](#license)
|
||||
- [References](#references)
|
||||
- [Contribute](#contribute)
|
||||
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
This subrepository contains the code to deploy the Project INCA Docs website, a project by [ThreeFold](https://threefold.io).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
You need [npm](https://www.npmjs.com/) to run this website.
|
||||
|
||||
To clone the repository, you need `git`.
|
||||
|
||||
To use the Makefile for quick deployment, you need `make`
|
||||
|
||||
### Install the prerequisites on Ubuntu
|
||||
```
|
||||
npm create astro@latest -- --template starlight
|
||||
sudo apt update
|
||||
sudo apt install nodejs
|
||||
sudo apt install git
|
||||
sudo apt install make
|
||||
```
|
||||
|
||||
[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
|
||||
[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
|
||||
### Install the prerequisites on MAC or Linux with Brew
|
||||
|
||||
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||||
- [Install Brew](https://brew.sh/)
|
||||
```
|
||||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
||||
```
|
||||
- Install the prerequisites
|
||||
```
|
||||
brew install node
|
||||
brew install git
|
||||
brew install make
|
||||
```
|
||||
|
||||
## 🚀 Project Structure
|
||||
|
||||
Inside of your Astro + Starlight project, you'll see the following folders and files:
|
||||
### Check if the Prerequisites Are Installed
|
||||
|
||||
```
|
||||
.
|
||||
├── public/
|
||||
├── src/
|
||||
│ ├── assets/
|
||||
│ ├── content/
|
||||
│ │ ├── docs/
|
||||
│ │ └── config.ts
|
||||
│ └── env.d.ts
|
||||
├── astro.config.mjs
|
||||
├── package.json
|
||||
└── tsconfig.json
|
||||
npm --version
|
||||
git version
|
||||
make --version
|
||||
```
|
||||
|
||||
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
|
||||
## Clone the Repository
|
||||
|
||||
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
|
||||
|
||||
Static assets, like favicons, can be placed in the `public/` directory.
|
||||
```
|
||||
git clone https://git.ourworld.tf/tfgrid/info_tfgrid
|
||||
cd info_tfgrid/docs_projectinca
|
||||
```
|
||||
|
||||
## 🧞 Commands
|
||||
For more information, read the original [AstroWind docs](./docs_starlight/starlight_README.md).
|
||||
|
||||
All commands are run from the root of the project, from a terminal:
|
||||
## Preview the Website
|
||||
|
||||
| Command | Action |
|
||||
| :------------------------ | :----------------------------------------------- |
|
||||
| `npm install` | Installs dependencies |
|
||||
| `npm run dev` | Starts local dev server at `localhost:4321` |
|
||||
| `npm run build` | Build your production site to `./dist/` |
|
||||
| `npm run preview` | Preview your build locally, before deploying |
|
||||
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||||
| `npm run astro -- --help` | Get help using the Astro CLI |
|
||||
You can preview the website with those two lines.
|
||||
|
||||
## 👀 Want to learn more?
|
||||
```
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
|
||||
The equivalent can be achieved using the Makefile:
|
||||
|
||||
```
|
||||
make run
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
**INCA Docs** is licensed under the Apache 2.0 license — see the [LICENSE](../LICENSE.md) file for details.
|
||||
|
||||
## References
|
||||
|
||||
This Project INCA Docs website is based on the amazing [AstroWind Starlight repo](https://github.com/withastro/starlight).
|
||||
|
||||
We changed the license from MIT to Apache 2.0 to suit this specific project.
|
||||
|
||||
## Contribute
|
||||
|
||||
To contribute to this repository:
|
||||
|
||||
- Make a new branch with `development_` as a prefix (e.g. `development_update`)
|
||||
- Make changes locally on your code editor
|
||||
- Push changes to the new branch
|
||||
- Make a pull request to `development` branch
|
||||
|
||||
The code owners will merge `development` branch to `main` branch.
|
||||
@ -5,16 +5,16 @@ import starlight from '@astrojs/starlight';
|
||||
export default defineConfig({
|
||||
integrations: [
|
||||
starlight({
|
||||
title: 'My Docs',
|
||||
title: 'Project INCA Docs',
|
||||
social: {
|
||||
github: 'https://github.com/withastro/starlight',
|
||||
github: 'https://github.com/threefoldtech',
|
||||
},
|
||||
sidebar: [
|
||||
{
|
||||
label: 'Guides',
|
||||
label: 'Start Here',
|
||||
items: [
|
||||
// Each item here is one entry in the navigation menu.
|
||||
{ label: 'Example Guide', link: '/guides/example/' },
|
||||
{ label: 'Getting Started', link: '/start_here/getting_started/' },
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
54
docs_projectinca/docs_starlight/starlight_README.md
Normal file
54
docs_projectinca/docs_starlight/starlight_README.md
Normal file
@ -0,0 +1,54 @@
|
||||
# Starlight Starter Kit: Basics
|
||||
|
||||
[](https://starlight.astro.build)
|
||||
|
||||
```
|
||||
npm create astro@latest -- --template starlight
|
||||
```
|
||||
|
||||
[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
|
||||
[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
|
||||
|
||||
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||||
|
||||
## 🚀 Project Structure
|
||||
|
||||
Inside of your Astro + Starlight project, you'll see the following folders and files:
|
||||
|
||||
```
|
||||
.
|
||||
├── public/
|
||||
├── src/
|
||||
│ ├── assets/
|
||||
│ ├── content/
|
||||
│ │ ├── docs/
|
||||
│ │ └── config.ts
|
||||
│ └── env.d.ts
|
||||
├── astro.config.mjs
|
||||
├── package.json
|
||||
└── tsconfig.json
|
||||
```
|
||||
|
||||
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
|
||||
|
||||
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
|
||||
|
||||
Static assets, like favicons, can be placed in the `public/` directory.
|
||||
|
||||
## 🧞 Commands
|
||||
|
||||
All commands are run from the root of the project, from a terminal:
|
||||
|
||||
| Command | Action |
|
||||
| :------------------------ | :----------------------------------------------- |
|
||||
| `npm install` | Installs dependencies |
|
||||
| `npm run dev` | Starts local dev server at `localhost:4321` |
|
||||
| `npm run build` | Build your production site to `./dist/` |
|
||||
| `npm run preview` | Preview your build locally, before deploying |
|
||||
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||||
| `npm run astro -- --help` | Get help using the Astro CLI |
|
||||
|
||||
## 👀 Want to learn more?
|
||||
|
||||
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
|
||||
@ -10,10 +10,10 @@
|
||||
"astro": "astro"
|
||||
},
|
||||
"dependencies": {
|
||||
"@astrojs/starlight": "^0.24.1",
|
||||
"astro": "^4.8.6",
|
||||
"sharp": "^0.32.5",
|
||||
"@astrojs/check": "^0.7.0",
|
||||
"@astrojs/starlight": "^0.24.2",
|
||||
"astro": "^4.10.2",
|
||||
"sharp": "^0.32.5",
|
||||
"typescript": "^5.4.5"
|
||||
}
|
||||
}
|
||||
BIN
docs_projectinca/src/assets/black_threefold.png
Normal file
BIN
docs_projectinca/src/assets/black_threefold.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 80 KiB |
BIN
docs_projectinca/src/assets/hero_host3.png
Normal file
BIN
docs_projectinca/src/assets/hero_host3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 670 KiB |
BIN
docs_projectinca/src/assets/inca_background.webp
Normal file
BIN
docs_projectinca/src/assets/inca_background.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 87 KiB |
@ -1,11 +0,0 @@
|
||||
---
|
||||
title: Example Guide
|
||||
description: A guide in my new Starlight docs site.
|
||||
---
|
||||
|
||||
Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
|
||||
Writing a good guide requires thinking about what your users are trying to do.
|
||||
|
||||
## Further reading
|
||||
|
||||
- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
|
||||
10
docs_projectinca/src/content/docs/guides/getstarted.md
Normal file
10
docs_projectinca/src/content/docs/guides/getstarted.md
Normal file
@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Get Started
|
||||
description: Earn INCA rewards by hosting nodes
|
||||
---
|
||||
|
||||
Earn INCA rewards by hosting nodes
|
||||
|
||||
## Get a Node
|
||||
|
||||
- Visit the official INCA website to [get INCA nodes](https://internetcapacity.org/)
|
||||
@ -1,36 +1,36 @@
|
||||
---
|
||||
title: Welcome to Starlight
|
||||
title: Welcome to the Project INCA Docs
|
||||
description: Get started building your docs site with Starlight.
|
||||
template: splash
|
||||
hero:
|
||||
tagline: Congrats on setting up a new Starlight project!
|
||||
tagline: Learn how to deploy INCA nodes to earn rewards!
|
||||
image:
|
||||
file: ../../assets/houston.webp
|
||||
file: ../../assets/hero_host3.png
|
||||
actions:
|
||||
- text: Example Guide
|
||||
link: /guides/example/
|
||||
- text: Get Started
|
||||
link: /guides/getstarted/
|
||||
icon: right-arrow
|
||||
variant: primary
|
||||
- text: Read the Starlight docs
|
||||
link: https://starlight.astro.build
|
||||
- text: Visit the website
|
||||
link: https://internetcapacity.org/
|
||||
icon: external
|
||||
---
|
||||
|
||||
import { Card, CardGrid } from '@astrojs/starlight/components';
|
||||
|
||||
## Next steps
|
||||
## Become a Cloud Service Provider
|
||||
|
||||
<CardGrid stagger>
|
||||
<Card title="Update content" icon="pencil">
|
||||
Edit `src/content/docs/index.mdx` to see this page change.
|
||||
<Card title="Learn about INCA" icon="open-book">
|
||||
Read the [INCA Docs](/guides/getstarted) to learn about the ecosystem.
|
||||
</Card>
|
||||
<Card title="Add new content" icon="add-document">
|
||||
Add Markdown or MDX files to `src/content/docs` to create new pages.
|
||||
<Card title="Get INCA Nodes" icon="add-document">
|
||||
You can get INCA nodes at the [official INCA website](https://internetcapacity.org/farming/).
|
||||
</Card>
|
||||
<Card title="Configure your site" icon="setting">
|
||||
Edit your `sidebar` and other config in `astro.config.mjs`.
|
||||
<Card title="Part of a Worldwide Grid" icon="setting">
|
||||
Project INCA is the fourth version of the [ThreeFold Grid](https://threefold.io/) available in 60+ countries!
|
||||
</Card>
|
||||
<Card title="Read the docs" icon="open-book">
|
||||
Learn more in [the Starlight Docs](https://starlight.astro.build/).
|
||||
<Card title="Earn INCA Rewards" icon="open-book">
|
||||
When you deploy INCA nodes, you contribute to the growth of the grid and earn INCA rewards!
|
||||
</Card>
|
||||
</CardGrid>
|
||||
|
||||
@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Get Started
|
||||
description: Earn INCA rewards by hosting nodes
|
||||
---
|
||||
|
||||
Earn INCA rewards by hosting nodes
|
||||
|
||||
## Get a Node
|
||||
|
||||
- Visit the official INCA website to [get INCA nodes](https://internetcapacity.org/)
|
||||
Loading…
Reference in New Issue
Block a user