You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Nyxian/docs/contributing/Nyxian.mdx
+19-15Lines changed: 19 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,11 @@
1
1
# Contributing to Nyxian
2
2
3
+
Thank you soooo much for your interest in Nyxian and contributing to it, I had the idea to make this file to show that im very confused about why nobody has contributed to Nyxian yet.
4
+
3
5
## Getting Started
4
6
5
7
### Prerequisites
6
-
- A mac with Xcode and Theos
8
+
- A mac with Xcode and Theos and the brew package dependencies(`pkgconf`, `cmake`, `libarchive`, `dpkg`)
7
9
- A iPhone/iPad with iOS 16+
8
10
- A free or paid apple developer account
9
11
- The certificate used to sign Nyxian (you can get that from keychain after installing Nyxian over Xcode).
Copy file name to clipboardExpand all lines: src/pages/website/contributing.mdx
+72-7Lines changed: 72 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,77 @@
1
1
# Contributing to this Website
2
2
3
-
## Quickstart
3
+
Select where you want to contribute below.
4
4
5
-
You can click the `Edit this page` button at the bottom of any page to start editing it on GitHub or you can go to [emexlab/emexlab.github.io](https://github.com/emexlab/emexlab.github.io/tree/main/).
5
+
<TabsqueryString="method">
6
+
<TabItemvalue="github"label="Github"default>
7
+
## Quickstart
6
8
7
-
:::tip[general tip]
9
+
You can click the `Edit this page` button at the bottom of any page to start editing it on GitHub or you can go to [emexlab/emexlab.github.io](https://github.com/emexlab/emexlab.github.io/tree/main/).
8
10
9
-
You can find more documentation at [docusaurus.io](https://docusaurus.io/docs/category/guides).
11
+
## Github Pages
12
+
13
+
You can find an automatic build of the newest state at https://emexlab.github.io/
14
+
</TabItem>
15
+
<TabItemvalue="local"label="Locally">
16
+
## Quickstart
17
+
18
+
```bash
19
+
./quickstart.sh
20
+
```
21
+
22
+
This script setups everything for you.
23
+
24
+
## Installation
25
+
26
+
```bash
27
+
npm install
28
+
```
29
+
30
+
## Local Development
31
+
32
+
```bash
33
+
npm run start
34
+
```
35
+
36
+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
37
+
38
+
## Build
39
+
40
+
```bash
41
+
npm run build
42
+
```
43
+
44
+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
45
+
46
+
## Deployment
47
+
48
+
### Github Pages
49
+
50
+
You can find an automatic build of the newest state at https://emexlab.github.io/
51
+
52
+
### SSH
53
+
54
+
```bash
55
+
./deploy.sh user@host
56
+
```
57
+
58
+
This will build the site and upload it via ssh to the specified host as the specified user.
59
+
60
+
:::note
61
+
62
+
It's recommended to set up SSH keys beforehand. Otherwise, pass `-n` and expect several SSH password prompts during deployment.
63
+
64
+
:::
65
+
</TabItem>
66
+
</Tabs>
67
+
68
+
69
+
:::tip
70
+
71
+
There is a [Todo](https://github.com/emexlab/emexlab.github.io#Todo) list in the README.
72
+
This is a good starting point for first time contributors.
73
+
74
+
The README also explains how to get started.
10
75
11
76
:::
12
77
@@ -15,7 +80,7 @@ You can find more documentation at [docusaurus.io](https://docusaurus.io/docs/ca
15
80
All files should be use `.mdx` instead of `.md`.
16
81
All folders must contain an `index.mdx`. These and all `.mdx` files directly in a `/docs` folder should also contain a value for `sidebar_position` in the metadata.
17
82
18
-
```mdx title="exampleDoc.mdx"
83
+
```mdx title="exampleDoc.mdx"
19
84
---
20
85
sidebar_position: 2
21
86
---
@@ -33,8 +98,8 @@ Please follow the best pratices from [markdownguide.org/basic-syntax](https://ww
33
98
34
99
:::tip
35
100
36
-
There is a [Todo](https://github.com/emexlab/emexlab.github.io#Todo) list in the README.
37
-
This is a good starting point for first time contributors
101
+
You can find more documentation at [docusaurus.io](https://docusaurus.io/docs/category/guides).
102
+
The websites github is also a good reference point: [docusaurus/website](https://github.com/facebook/docusaurus/tree/main/website)
0 commit comments